AutoIt

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. AutoIt

Local $bSuccess = False

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

$oHttp = ObjCreate("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.
$oHttp.AuthToken = "YOUR_API_KEY"
$oHttp.SetRequestHeader "Content-Type","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://staging-api.yousign.com/users",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sName
Local $strVal

Local $sId = $oJResp.StringOf("id")
Local $sFirstname = $oJResp.StringOf("firstname")
Local $sLastname = $oJResp.StringOf("lastname")
Local $sEmail = $oJResp.StringOf("email")
Local $sTitle = $oJResp.StringOf("title")
Local $sPhone = $oJResp.StringOf("phone")
Local $status = $oJResp.StringOf("status")
Local $sOrganization = $oJResp.StringOf("organization")
Local $sPermission = $oJResp.StringOf("permission")
Local $sGroupId = $oJResp.StringOf("group.id")
Local $sGroupName = $oJResp.StringOf("group.name")
Local $sCreatedAt = $oJResp.StringOf("createdAt")
Local $sUpdatedAt = $oJResp.StringOf("updatedAt")
Local $bDeleted = $oJResp.BoolOf("deleted")
Local $sDeletedAt = $oJResp.StringOf("deletedAt")
Local $sInweboUserRequest = $oJResp.StringOf("inweboUserRequest")
Local $samlNameId = $oJResp.StringOf("samlNameId")
Local $sDefaultSignImage = $oJResp.StringOf("defaultSignImage")
Local $bNotificationsProcedure = $oJResp.BoolOf("notifications.procedure")
Local $bFastSign = $oJResp.BoolOf("fastSign")
Local $sFullName = $oJResp.StringOf("fullName")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("workspaces")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("workspaces[i].id")
    $sName = $oJResp.StringOf("workspaces[i].name")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("group.permissions")
While $i < $iCount_i
    $oJResp.I = $i
    $strVal = $oJResp.StringOf("group.permissions[i]")
    $i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("config")
While $i < $iCount_i
    $oJResp.I = $i
    $i = $i + 1
Wend