Xbase++

Square API - Create Catalog Image

See more Square Examples

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

LOCAL nSuccess
LOCAL oHttp
LOCAL oReq
LOCAL oJson
LOCAL oResp
LOCAL oSbResponseBody
LOCAL oJResp
LOCAL nRespStatusCode
LOCAL cImageType
LOCAL cImageId
LOCAL cImageUpdated_at
LOCAL nImageVersion
LOCAL nImageIs_deleted
LOCAL nImagePresent_at_all_locations
LOCAL cImageImage_dataName
LOCAL cImageImage_dataUrl
LOCAL cImageImage_dataCaption

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

//  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

oReq := CreateObject("Chilkat.HttpRequest")
oReq:HttpVerb := "POST"
oReq:Path := "/v2/catalog/images"
oReq:ContentType := "multipart/form-data"
nSuccess := oReq:AddFileForUpload2("file", "/local/path/to/file.jpg", "image/jpeg")

//  Make sure to use an object_id for an already-existing catalog item.
oJson := CreateObject("Chilkat.JsonObject")
oJson:UpdateString("idempotency_key", "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86")
oJson:UpdateString("object_id", "2PTZYUOFGGDMT75UZLHQAPAC")
oJson:UpdateString("image.id", "#TEMP_ID")
oJson:UpdateString("image.type", "IMAGE")
oJson:UpdateString("image.image_data.caption", "A picture of a cup of coffee")

oReq:AddParam("request", oJson:Emit())

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

//  This example uses the sandbox: connect.squareupsandbox.com
//  Production should use connect.squareup.com
oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpSReq("connect.squareupsandbox.com", 443, 1, oReq, oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oReq:destroy()
    oJson:destroy()
    oResp:destroy()
    RETURN
ENDIF

oSbResponseBody := CreateObject("Chilkat.StringBuilder")
oResp:GetBodySb(oSbResponseBody)
oJResp := CreateObject("Chilkat.JsonObject")
oJResp:LoadSb(oSbResponseBody)
oJResp:EmitCompact := 0

? "Response Body:"
? oJResp:Emit()

nRespStatusCode := oResp:StatusCode
? "Response Status Code = " + Str(nRespStatusCode)
IF (nRespStatusCode >= 400)
    ? "Response Header:"
    ? oResp:Header
    ? "Failed."
    oHttp:destroy()
    oReq:destroy()
    oJson:destroy()
    oResp:destroy()
    oSbResponseBody:destroy()
    oJResp:destroy()
    RETURN
ENDIF

//  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

cImageType := oJResp:StringOf("image.type")
cImageId := oJResp:StringOf("image.id")
cImageUpdated_at := oJResp:StringOf("image.updated_at")
nImageVersion := oJResp:IntOf("image.version")
nImageIs_deleted := oJResp:BoolOf("image.is_deleted")
nImagePresent_at_all_locations := oJResp:BoolOf("image.present_at_all_locations")
cImageImage_dataName := oJResp:StringOf("image.image_data.name")
cImageImage_dataUrl := oJResp:StringOf("image.image_data.url")
cImageImage_dataCaption := oJResp:StringOf("image.image_data.caption")

oHttp:destroy()
oReq:destroy()
oJson:destroy()
oResp:destroy()
oSbResponseBody:destroy()
oJResp:destroy()