Chilkat Online Tools

Python / DocuSign eSignature REST API / Returns a URL to the authentication view UI.

Back to Collection Items

import sys
import chilkat2

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = chilkat2.Http()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "envelopeId": "sample string 1",
#   "returnUrl": "sample string 2"
# }

json = chilkat2.JsonObject()
json.UpdateString("envelopeId","sample string 1")
json.UpdateString("returnUrl","sample string 2")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/views/console","application/json",json)
if (http.LastMethodSuccess == False):
    print(http.LastErrorText)
    sys.exit()

print(str(resp.StatusCode))
print(resp.BodyStr)

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "envelopeId": "sample string 1",
  "returnUrl": "sample string 2"
}'
https://domain.com/v2.1/accounts/{{accountId}}/views/console

Postman Collection Item JSON

{
  "name": "Returns a URL to the authentication view UI.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"envelopeId\": \"sample string 1\",\n  \"returnUrl\": \"sample string 2\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/views/console",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "views",
        "console"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications."
  },
  "response": [
  ]
}