C++

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. C++

#include <CkHttp.h>
#include <CkHttpRequest.h>
#include <CkJsonObject.h>
#include <CkHttpResponse.h>
#include <CkStringBuilder.h>

void ChilkatSample(void)
    {
    bool success = false;

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

    CkHttp 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

    CkHttpRequest req;
    req.put_HttpVerb("POST");
    req.put_Path("/v2/catalog/images");
    req.put_ContentType("multipart/form-data");
    success = req.AddFileForUpload2("file","/local/path/to/file.jpg","image/jpeg");

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

    req.AddParam("request",json.emit());

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

    //  This example uses the sandbox: connect.squareupsandbox.com
    //  Production should use connect.squareup.com
    CkHttpResponse resp;
    success = http.HttpSReq("connect.squareupsandbox.com",443,true,req,resp);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkStringBuilder sbResponseBody;
    resp.GetBodySb(sbResponseBody);
    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = resp.get_StatusCode();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << resp.header() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

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

    //  Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
    //  See this example explaining how this memory should be used: const char * functions.

    const char *imageType = jResp.stringOf("image.type");
    const char *imageId = jResp.stringOf("image.id");
    const char *imageUpdated_at = jResp.stringOf("image.updated_at");
    int imageVersion = jResp.IntOf("image.version");
    bool imageIs_deleted = jResp.BoolOf("image.is_deleted");
    bool imagePresent_at_all_locations = jResp.BoolOf("image.present_at_all_locations");
    const char *imageImage_dataName = jResp.stringOf("image.image_data.name");
    const char *imageImage_dataUrl = jResp.stringOf("image.image_data.url");
    const char *imageImage_dataCaption = jResp.stringOf("image.image_data.caption");
    }