Chilkat Online Tools

phpExt / DocuSign eSignature REST API / 14. Created Embedded View

Back to Collection Items

<?php

include("chilkat.php");

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

$http = new CkHttp();

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

// The following JSON is sent in the request body.

// {
//   "returnUrl": "http://httpbin.org/get",
//   "authenticationMethod": "none",
//   "email": "{{email}}",
//   "userName": "{{userName}}"
// }

$json = new CkJsonObject();
$json->UpdateString('returnUrl','http://httpbin.org/get');
$json->UpdateString('authenticationMethod','none');
$json->UpdateString('email','{{email}}');
$json->UpdateString('userName','{{userName}}');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$resp = new CkHttpResponse();
$success = $http->HttpJson('POST','https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview',$json,'application/json',$resp);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";

?>

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "returnUrl": "http://httpbin.org/get",
    "authenticationMethod": "none",
    "email": {{user1}},
    "userName": {{user1_name}}
}'
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview

Postman Collection Item JSON

{
  "name": "14. Created Embedded View",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{accessToken}}",
          "type": "string"
        }
      ]
    },
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"returnUrl\": \"http://httpbin.org/get\",\n    \"authenticationMethod\": \"none\",\n    \"email\": {{user1}},\n    \"userName\": {{user1_name}}\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId_draft}}/views/recipient_preview",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId_draft}}",
        "views",
        "recipient_preview"
      ]
    },
    "description": "In this example, we will create an embedded preview of what our recipients see when the envelope is sent out to them."
  },
  "response": [
  ]
}