Create Image API V2

Synopsis

This API function creates an image defined in the JSON. The response will return a JPG image file for download. Image details like background image URL, barcode, and text areas may be provided.

• An image must have some data added in the request.
• At least one of the following is required for an image: background image, barcode, and/or text area. The request will fail if none are included.
• The background image URL in the image supports jpg image file type. If the background image is not a jpg or if the image does not exist, then the request will fail. Recommendations for background image are jpg image type, 640x1138px size, and 200 KB file size.
• If a barcode is added in the image, then the barcode id is required. The request will fail if a barcode is added without a barcode id. The barcode id will appear at the bottom center of the barcode by default and can be hidden by passing the boolean value true to “hide-text”. Both the barcode and the barcode id can be customized based on the details passed in the request. Barcode customizations include barcode type, x/y position, width/height, foreground/background color, border width, transparency, alignment, and rotation. Barcode id customizations include font style/size, and the color of the barcode id is based on the foreground color.
• A dynamic image supports up to 8 text areas. Each text area requires text to be added. The request will fail if a text area is added without text. Text area customizations include x/y position, font style/size/color, and width.

Request: JSON

curl -X POST \ 
     -H "x-api-key: {Api Key}" \
     -H "content-type: application/json" -d '
      {
          "action": "createimage",
          "background-image-url": "{Background image url}",
          "add-barcode": "{yes/no}",
          "barcode": {
              "id": "{Barcode text}",
              "position-x": "{x coordinate value in pixels}",
              "position-y": "{y coordinate value in pixels}",
              "width": "{Width of barcode in pixels}",
              "height": "{Height of barcode in pixels}",
              "foreground-color": "{Foreground color of barcode in hexadecimal value}",
              "background-color": "{Background color of barcode in hexadecimal value}",
              "border-width": "{Width of barcode border in pixels}",
              "type": "{Barcode type}",
              "hide-text": true/false,
              "transparent": true/false,
              "font": "{Font style}",
              "font-size": "{Font size}",
              "alignment": "{Left/Center/Right}",
              "rotate": "{0/90/180/270}"
          },
          "add-text-area": "{yes/no}",
          "text-area": {
              "text-area-1": {
                  "text": "{Text within the text area field}",
                  "position-x": "{x coordinate value in pixels}",
                  "position-y": "{y coordinate value in pixels}",
                  "font": "{Font style}",
                  "font-size": "{Font size}",
                  "font-color": "{Font color in hexadecimal value}",
                  "width": "{Width of the text area field}"
              }
              ...
          }
      }' \
  "{Api Endpoint URL}"

Request Parameters

Response Parameters

Request Example: JSON

curl -X POST \ 
     -H "x-api-key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
     -H "content-type: application/json" -d '
      {
          "action": "createimage",
          "background-image-url": "https://fake-content-url.com/background.png",
          "add-barcode": "yes",
          "barcode": {
              "id": "QR Code",
              "position-x": 0,
              "position-y": 0,
              "width": 11,
              "height": 11,
              "foreground-color": "#000000",
              "background-color": "#ffffff",
              "border-width": 0,
              "type": "QR Code",
              "hide-text": false,
              "transparent": false,
              "font": "OpenSans",
              "font-size": 20,
              "alignment": "Left",
              "rotate": 0
          },
          "add-text-area": "yes",
          "text-area": {
              "text-area-1": {
                  "text": "Text to be used in the text area",
                  "position-x": 10,
                  "position-y": 10,
                  "font": "OpenSans",
                  "font-size": 20,
                  "font-color": "#000000",
                  "width": 100
              }
          }
      }' \
  "{Api Endpoint URL}"

Response Example: Success

Output the dynamic image file to download (.jpg file)
Content-type: image/jpeg; charset=utf-8;
Content-Disposition: inline; filename=image-template-6053bb7aac39a-2021-03-18T20:43:38Z.jpg;

Response Example: Failure

{
    "status": "failure",
    "error-code": "E1913",
    "error-info": "Dynamic Image: A background image, barcode, or at least one text area is required."
}