(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpRequest, StringBuilder, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
http: HCkHttp;
success: Boolean;
req: HCkHttpRequest;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
imageType: PWideChar;
imageId: PWideChar;
imageUpdated_at: PWideChar;
imageVersion: Integer;
imageIs_deleted: Boolean;
imagePresent_at_all_locations: Boolean;
imageImage_dataName: PWideChar;
imageImage_dataUrl: PWideChar;
imageImage_dataCaption: PWideChar;

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

http := CkHttp_Create();

// 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 := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(req,'/v2/catalog/images');
CkHttpRequest_putContentType(req,'multipart/form-data');
success := CkHttpRequest_AddFileForUpload2(req,'file','/local/path/to/file.jpg','image/jpeg');

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

CkHttpRequest_AddParam(req,'request',CkJsonObject__emit(json));

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

// This example uses the sandbox: connect.squareupsandbox.com
// Production should use connect.squareup.com
resp := CkHttp_SynchronousRequest(http,'connect.squareupsandbox.com',443,True,req);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(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 := CkJsonObject__stringOf(jResp,'image.type');
imageId := CkJsonObject__stringOf(jResp,'image.id');
imageUpdated_at := CkJsonObject__stringOf(jResp,'image.updated_at');
imageVersion := CkJsonObject_IntOf(jResp,'image.version');
imageIs_deleted := CkJsonObject_BoolOf(jResp,'image.is_deleted');
imagePresent_at_all_locations := CkJsonObject_BoolOf(jResp,'image.present_at_all_locations');
imageImage_dataName := CkJsonObject__stringOf(jResp,'image.image_data.name');
imageImage_dataUrl := CkJsonObject__stringOf(jResp,'image.image_data.url');
imageImage_dataCaption := CkJsonObject__stringOf(jResp,'image.image_data.caption');

CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

end;