(Excel) Yousign: Making your first API call

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

For more information, see https://dev.yousign.com/?version=latest#c803dbec-2afb-4b2d-b70b-b42e5c8cbc9a

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

' 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.
http.AuthToken = "YOUR_API_KEY"
http.SetRequestHeader "Content-Type","application/json"

Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = http.QuickGetSb("https://staging-api.yousign.com/users",sbResponseBody)
If (success = False) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As Chilkat.JsonObject
Set jResp = Chilkat.NewJsonObject
Dim success As Boolean
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.Print "Response Body:"
Debug.Print jResp.Emit()


respStatusCode = http.LastStatus
Debug.Print "Response Status Code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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


id = jResp.StringOf("id")

firstname = jResp.StringOf("firstname")

lastname = jResp.StringOf("lastname")

email = jResp.StringOf("email")

title = jResp.StringOf("title")

phone = jResp.StringOf("phone")

status = jResp.StringOf("status")

organization = jResp.StringOf("organization")

permission = jResp.StringOf("permission")

groupId = jResp.StringOf("group.id")

groupName = jResp.StringOf("group.name")

createdAt = jResp.StringOf("createdAt")

updatedAt = jResp.StringOf("updatedAt")

deleted = jResp.BoolOf("deleted")

deletedAt = jResp.StringOf("deletedAt")

inweboUserRequest = jResp.StringOf("inweboUserRequest")

samlNameId = jResp.StringOf("samlNameId")

defaultSignImage = jResp.StringOf("defaultSignImage")

notificationsProcedure = jResp.BoolOf("notifications.procedure")

fastSign = jResp.BoolOf("fastSign")

fullName = jResp.StringOf("fullName")

i = 0

count_i = jResp.SizeOfArray("workspaces")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("workspaces[i].id")
    name = jResp.StringOf("workspaces[i].name")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("group.permissions")
Do While i < count_i
    jResp.I = i
    strVal = jResp.StringOf("group.permissions[i]")
    i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("config")
Do While i < count_i
    jResp.I = i
    i = i + 1
Loop