PureBasic

Yousign: Download Information about Previously Uploaded File

See more Yousign Examples

Demonstrates how to download the information (in JSON format) about a file previously uploaded. PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Implements the following CURL command:

    ; curl --location --request GET 'https://staging-api.yousign.com/files/{{id}}' \
    ; --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.
    CkHttp::setCkAuthToken(http, "YOUR_API_KEY")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://staging-api.yousign.com/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

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

    ; {
    ;   "id": "/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    ;   "name": "The best name for my file.pdf",
    ;   "type": "signable",
    ;   "contentType": "application/pdf",
    ;   "description": null,
    ;   "createdAt": "2018-12-07T08:10:21+01:00",
    ;   "updatedAt": "2018-12-07T08:10:21+01:00",
    ;   "sha256": "bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2",
    ;   "metadata": [
    ;   ],
    ;   "workspace": "/workspaces/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    ;   "creator": null,
    ;   "protected": false,
    ;   "position": 0,
    ;   "parent": null
    ; }

    ; 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.s = CkJsonObject::ckStringOf(jResp,"id")
    name.s = CkJsonObject::ckStringOf(jResp,"name")
    v_type.s = CkJsonObject::ckStringOf(jResp,"type")
    contentType.s = CkJsonObject::ckStringOf(jResp,"contentType")
    description.s = CkJsonObject::ckStringOf(jResp,"description")
    createdAt.s = CkJsonObject::ckStringOf(jResp,"createdAt")
    updatedAt.s = CkJsonObject::ckStringOf(jResp,"updatedAt")
    sha256.s = CkJsonObject::ckStringOf(jResp,"sha256")
    workspace.s = CkJsonObject::ckStringOf(jResp,"workspace")
    creator.s = CkJsonObject::ckStringOf(jResp,"creator")
    v_protected.i = CkJsonObject::ckBoolOf(jResp,"protected")
    position.i = CkJsonObject::ckIntOf(jResp,"position")
    parent.s = CkJsonObject::ckStringOf(jResp,"parent")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"metadata")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure