Chilkat Online Tools

PureBasic / PandaDoc API Reference / Share Document (Session ID)

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

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

    ; The following JSON is sent in the request body.

    ; {
    ;   "recipient": "{{recipient_email}}",
    ;   "lifetime": 900
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"recipient","{{recipient_email}}")
    CkJsonObject::ckUpdateInt(json,"lifetime",900)

    CkHttp::ckSetRequestHeader(http,"Authorization","API-Key {{api_key}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.pandadoc.com/public/v1/documents/{{document_id}}/session","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "Authorization: Bearer {{access_token}}"
	-H "Authorization: API-Key {{api_key}}"
	-H "Content-Type: application/json"
	-d '{
    "recipient": "{{recipient_email}}",
    "lifetime": 900
}'
https://api.pandadoc.com/public/v1/documents/{{document_id}}/session

Postman Collection Item JSON

{
  "name": "Share Document (Session ID)",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "if (jsonData.id !== undefined) {",
          "    postman.setEnvironmentVariable(\"session_id\", jsonData.id);",
          "}"
        ]
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{access_token}}",
        "disabled": true
      },
      {
        "key": "Authorization",
        "value": "API-Key {{api_key}}",
        "type": "text"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"recipient\": \"{{recipient_email}}\",\n    \"lifetime\": 900\n}"
    },
    "url": {
      "raw": "https://api.pandadoc.com/public/v1/documents/{{document_id}}/session",
      "protocol": "https",
      "host": [
        "api",
        "pandadoc",
        "com"
      ],
      "path": [
        "public",
        "v1",
        "documents",
        "{{document_id}}",
        "session"
      ]
    },
    "description": "For details go to [https://developers.pandadoc.com/v1/reference#link-to-a-document](https://developers.pandadoc.com/v1/reference#link-to-a-document).\n\nFor details of document sharing go to [https://developers.pandadoc.com/v1/reference#share-document](https://developers.pandadoc.com/v1/reference#share-document)."
  },
  "response": [
  ]
}