(PureBasic) Square API - Create Catalog Image

Uploads an image file to be represented by an CatalogImage object linked to an existing CatalogObject instance.

For more information, see https://developer.squareup.com/reference/square/catalog-api/create-catalog-image

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    ; 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

    success.i

    ; Implements the following CURL command:

    ; curl https://connect.squareup.com/v2/catalog/images \
    ;   -X POST \
    ;   -H 'Square-Version: 2020-07-22' \
    ;   -H 'Authorization: Bearer ACCESS_TOKEN' \
    ;   -H 'Accept: application/json' \
    ;   -F 'file=@/local/path/to/file.jpg' \
    ;   -F 'request={
    ;     "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
    ;     "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
    ;     "image": {
    ;       "id": "#TEMP_ID",
    ;       "type": "IMAGE",
    ;       "image_data": {
    ;         "caption": "A picture of a cup of coffee"
    ;       }
    ;     }
    ;   }'

    ; Use the following online tool to generate HTTP code from a CURL command
    ; Convert a cURL Command to HTTP Source Code

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

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/v2/catalog/images")
    CkHttpRequest::setCkContentType(req, "multipart/form-data")
    success = CkHttpRequest::ckAddFileForUpload2(req,"file","/local/path/to/file.jpg","image/jpeg")

    ; Make sure to use an object_id for an already-existing catalog item.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"idempotency_key","528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
    CkJsonObject::ckUpdateString(json,"object_id","2PTZYUOFGGDMT75UZLHQAPAC")
    CkJsonObject::ckUpdateString(json,"image.id","#TEMP_ID")
    CkJsonObject::ckUpdateString(json,"image.type","IMAGE")
    CkJsonObject::ckUpdateString(json,"image.image_data.caption","A picture of a cup of coffee")

    CkHttpRequest::ckAddParam(req,"request",CkJsonObject::ckEmit(json))

    CkHttpRequest::ckAddHeader(req,"Expect","100-continue")
    CkHttpRequest::ckAddHeader(req,"Authorization","Bearer ACCESS_TOKEN")
    CkHttpRequest::ckAddHeader(req,"Accept","application/json")
    CkHttpRequest::ckAddHeader(req,"Square-Version","2020-07-22")

    ; This example uses the sandbox: connect.squareupsandbox.com
    ; Production should use connect.squareup.com
    resp.i = CkHttp::ckSynchronousRequest(http,"connect.squareupsandbox.com",443,1,req)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

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

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
    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 = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; {
    ;   "image": {
    ;     "type": "IMAGE",
    ;     "id": "UBXKMBQ4QK47QXMNQD6ELCZT",
    ;     "updated_at": "2020-08-07T15:20:09.779Z",
    ;     "version": 1596813609779,
    ;     "is_deleted": false,
    ;     "present_at_all_locations": true,
    ;     "image_data": {
    ;       "name": "",
    ;       "url": "https://square-catalog-sandbox.s3.amazonaws.com/files/168973eab6f8b39b5cbdad52e3f82b23be196e2b/original.jpeg",
    ;       "caption": "A picture of a cup of coffee"
    ;     }
    ;   }
    ; }

    ; Sample code for parsing the JSON response...
    ; Use the following online tool to generate parsing code from sample JSON:
    ; Generate Parsing Code from JSON

    imageType.s = CkJsonObject::ckStringOf(jResp,"image.type")
    imageId.s = CkJsonObject::ckStringOf(jResp,"image.id")
    imageUpdated_at.s = CkJsonObject::ckStringOf(jResp,"image.updated_at")
    imageVersion.i = CkJsonObject::ckIntOf(jResp,"image.version")
    imageIs_deleted.i = CkJsonObject::ckBoolOf(jResp,"image.is_deleted")
    imagePresent_at_all_locations.i = CkJsonObject::ckBoolOf(jResp,"image.present_at_all_locations")
    imageImage_dataName.s = CkJsonObject::ckStringOf(jResp,"image.image_data.name")
    imageImage_dataUrl.s = CkJsonObject::ckStringOf(jResp,"image.image_data.url")
    imageImage_dataCaption.s = CkJsonObject::ckStringOf(jResp,"image.image_data.caption")


    CkHttp::ckDispose(http)
    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure