Lianja

Yousign: Making your first API call

See more Yousign Examples

Demonstrates making the simplest of calls to test your API key. This example tests using the sandbox URLs. Lianja

llSuccess = .F.

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

loHttp = createobject("CkHttp")

// Implements the following CURL command:

// curl --location --request GET 'https://staging-api.yousign.com/users' \
// --header 'Authorization: Bearer YOUR_API_KEY' \
// --header 'Content-Type: application/json'

// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code

// Adds the "Authorization: Bearer YOUR_API_KEY" header.
loHttp.AuthToken = "YOUR_API_KEY"
loHttp.SetRequestHeader("Content-Type","application/json")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://staging-api.yousign.com/users",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "/users/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "firstname": "John",
//   "lastname": "Doe",
//   "email": "john.doe@yousign.fr",
//   "title": "Developer",
//   "phone": "+33612345678",
//   "status": "activated",
//   "organization": "/organizations/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//   "workspaces": [
//     {
//       "id": "/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//       "name": "Acme"
//     }
//   ],
//   "permission": "ROLE_ADMIN",
//   "group": {
//     "id": "/user_groups/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
//     "name": "Administrateur",
//     "permissions": [
//       "procedure_write",
//       "procedure_template_write",
//       "procedure_create_from_template",
//       "contact",
//       "sign",
//       "organization",
//       "user",
//       "api_key",
//       "procedure_custom_field",
//       "signature_ui",
//       "certificate",
//       "archive"
//     ]
//   },
//   "createdAt": "2018-12-01T09:42:25+01:00",
//   "updatedAt": "2018-12-01T09:42:25+01:00",
//   "deleted": false,
//   "deletedAt": null,
//   "config": [
//   ],
//   "inweboUserRequest": null,
//   "samlNameId": null,
//   "defaultSignImage": null,
//   "notifications": {
//     "procedure": true
//   },
//   "fastSign": false,
//   "fullName": "John Doe"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

lcId = loJResp.StringOf("id")
lcFirstname = loJResp.StringOf("firstname")
lcLastname = loJResp.StringOf("lastname")
lcEmail = loJResp.StringOf("email")
lcTitle = loJResp.StringOf("title")
lcPhone = loJResp.StringOf("phone")
lcStatus = loJResp.StringOf("status")
lcOrganization = loJResp.StringOf("organization")
lcPermission = loJResp.StringOf("permission")
lcGroupId = loJResp.StringOf("group.id")
lcGroupName = loJResp.StringOf("group.name")
lcCreatedAt = loJResp.StringOf("createdAt")
lcUpdatedAt = loJResp.StringOf("updatedAt")
llDeleted = loJResp.BoolOf("deleted")
lcDeletedAt = loJResp.StringOf("deletedAt")
lcInweboUserRequest = loJResp.StringOf("inweboUserRequest")
lcSamlNameId = loJResp.StringOf("samlNameId")
lcDefaultSignImage = loJResp.StringOf("defaultSignImage")
llNotificationsProcedure = loJResp.BoolOf("notifications.procedure")
llFastSign = loJResp.BoolOf("fastSign")
lcFullName = loJResp.StringOf("fullName")
i = 0
lnCount_i = loJResp.SizeOfArray("workspaces")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("workspaces[i].id")
    lcName = loJResp.StringOf("workspaces[i].name")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("group.permissions")
do while i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("group.permissions[i]")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("config")
do while i < lnCount_i
    loJResp.I = i
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp