DataFlex
DataFlex
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.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sName
String sStrVal
String sId
String sFirstname
String sLastname
String sEmail
String sTitle
String sPhone
String sStatus
String sOrganization
String sPermission
String sGroupId
String sGroupName
String sCreatedAt
String sUpdatedAt
Boolean iDeleted
String sDeletedAt
String sInweboUserRequest
String sSamlNameId
String sDefaultSignImage
Boolean iNotificationsProcedure
Boolean iFastSign
String sFullName
Integer i
Integer iCount_i
String sTemp1
Move False To iSuccess
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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.
Set ComAuthToken Of hoHttp To "YOUR_API_KEY"
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://staging-api.yousign.com/users" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "id" To sId
Get ComStringOf Of hoJResp "firstname" To sFirstname
Get ComStringOf Of hoJResp "lastname" To sLastname
Get ComStringOf Of hoJResp "email" To sEmail
Get ComStringOf Of hoJResp "title" To sTitle
Get ComStringOf Of hoJResp "phone" To sPhone
Get ComStringOf Of hoJResp "status" To sStatus
Get ComStringOf Of hoJResp "organization" To sOrganization
Get ComStringOf Of hoJResp "permission" To sPermission
Get ComStringOf Of hoJResp "group.id" To sGroupId
Get ComStringOf Of hoJResp "group.name" To sGroupName
Get ComStringOf Of hoJResp "createdAt" To sCreatedAt
Get ComStringOf Of hoJResp "updatedAt" To sUpdatedAt
Get ComBoolOf Of hoJResp "deleted" To iDeleted
Get ComStringOf Of hoJResp "deletedAt" To sDeletedAt
Get ComStringOf Of hoJResp "inweboUserRequest" To sInweboUserRequest
Get ComStringOf Of hoJResp "samlNameId" To sSamlNameId
Get ComStringOf Of hoJResp "defaultSignImage" To sDefaultSignImage
Get ComBoolOf Of hoJResp "notifications.procedure" To iNotificationsProcedure
Get ComBoolOf Of hoJResp "fastSign" To iFastSign
Get ComStringOf Of hoJResp "fullName" To sFullName
Move 0 To i
Get ComSizeOfArray Of hoJResp "workspaces" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "workspaces[i].id" To sId
Get ComStringOf Of hoJResp "workspaces[i].name" To sName
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "group.permissions" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "group.permissions[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "config" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move (i + 1) To i
Loop
End_Procedure