Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loHttp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcStrVal
LOCAL lcId
LOCAL lcFirstname
LOCAL lcLastname
LOCAL lcEmail
LOCAL lcTitle
LOCAL lcPhone
LOCAL lcStatus
LOCAL lcOrganization
LOCAL lcPermission
LOCAL lcGroupId
LOCAL lcGroupName
LOCAL lcCreatedAt
LOCAL lcUpdatedAt
LOCAL lnDeleted
LOCAL lcDeletedAt
LOCAL lcInweboUserRequest
LOCAL lcSamlNameId
LOCAL lcDefaultSignImage
LOCAL lnNotificationsProcedure
LOCAL lnFastSign
LOCAL lcFullName
LOCAL i
LOCAL lnCount_i

lnSuccess = 0

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

loHttp = CreateObject('Chilkat.Http')

* 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('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://staging-api.yousign.com/users",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "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
    CANCEL
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")
lnDeleted = loJResp.BoolOf("deleted")
lcDeletedAt = loJResp.StringOf("deletedAt")
lcInweboUserRequest = loJResp.StringOf("inweboUserRequest")
lcSamlNameId = loJResp.StringOf("samlNameId")
lcDefaultSignImage = loJResp.StringOf("defaultSignImage")
lnNotificationsProcedure = loJResp.BoolOf("notifications.procedure")
lnFastSign = 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