Production Integration - Generic API

Production Integration - Generic API

Introduction

The Generic API production integration pushes batch data and related order data, in JSON format, to an API endpoint.  The integration makes it easy for fulfillers with in-house developers, to ingest this data and produce jobs outside of the Kornit X Platform.

The integration is compatible with both artwork processing job templates and non-artwork processing job templates (also known as a consolidation job template).

The integration can be set up on any production centre company.  Job templates are assigned to a production centre during job template set up.  Any jobs that are created using job templates assigned to the production centre, will be pushed to the endpoint defined in the integration settings.

Setting up the Integration

  1. Go to Settings>Companies and filter the company type to Production Centre (or click here).
  2. Click on the production centre that you wish to set up the integration on, to view details for that company.
  3. Select the Production Integrations tab on the left.

  1. Click on Generic API to view the integration settings.



Explanation of the Integration Settings



Enabled - Toggle whether the integration is enabled or disabled.
Auto Transfer Enabled - When enabled, jobs will be automatically pushed to the API endpoint URL once they reach a Pending Production status.  (See the "Run Interval" setting below for how often this happens).  When disabled, jobs will only be pushed to the API endpoint URL when the Send to Production button is clicked in the UI.  There are 2 ways to send a job to production.
  1. For a single job, the Send to Production button appears to the right when you hover over the job.

  1. For multiple jobs, you can select them and use the Send to Production button that appears at the top of the jobs list.


Run Interval - Select how frequent jobs are pushed to the API endpoint URL.  The options here are "Always", "Quarter-Hourly", "Hourly" or "Daily (Midnight UTC)".  (This option only appears when the Auto Transfer option is enabled).
Start Timestamp (UTC) - The start date and time of the integration.  Only jobs created after this time will be pushed to the API endpoint URL.  (This option only appears when the Auto Transfer option is enabled).
API URL - The endpoint URL that the data will be pushed to.
Request Strategy - There is currently only one option here which is "Manual Override".  The value that must be entered in the box below is "SL\Proxy2\Production\GenericApi\RequestStrategy" (without quotations).
Preferred Artwork Format - The format of the artwork URL's that will be pushed to the endpoint.  The options here are "PNG", "JPG" or "PDF".

Once the integration has been configured, click Save to enable the integration.  An example configuration (with a dummy endpoint URL) is shown below.



Example JSON Data

To give an idea of the job data that's sent to the API endpoint, two examples are provided below.  The first is for an artwork processing job and the second is for a consolidation job.

Example Artwork Processing Job Data

  2. {
  3.    "id":9972081,
  4.    "artwork":{
  5.       "artwork.png":[
  6.          "https:\/\/s3-eu-west-1.amazonaws.com\/generated-assets-gateway3d-com\/batch\/dlp6123cyc\/flat.png",
  7.          "s3:\/\/generated-assets-gateway3d-com\/batch\/dlp6123cyc\/flat.png"
  8.       ]
  9.    },
  10.    "items":[
  11.       {
  12.          "id":19156817,
  13.          "order_item_id":71126037,
  14.          "batch_job_id":9972081,
  15.          "series_number":1,
  16.          "series_total":1,
  17.          "order":{
  18.             "id":"POS-80DAF4",
  19.             "ref":"ADD14AE3630E28DA",
  20.             "external_ref":"POS-80DAF4",
  21.             "customer_name":"Test Testing",
  22.             "shipping_address_1":"Pinewood Court",
  23.             "shipping_address_2":"",
  24.             "shipping_address_3":"",
  25.             "shipping_address_4":"Macclesfield",
  26.             "shipping_address_5":"Cheshire",
  27.             "shipping_postcode":"SK10 2XR",
  28.             "shipping_country_code":"GB",
  29.             "shipping_carrier":"Hermes",
  30.             "shipping_method":""
  31.          },
  32.          "order_item":{
  33.             "id":71126037,
  34.             "type":2,
  35.             "mapped_sku":"SGS7E-CS-G-TEST",
  36.             "sku":"SGS7E-CS-G-TEST",
  37.             "description":"Samsung Galaxy 7 Edge Snap In Gloss",
  38.             "quantity":1,
  39.             "artwork":null
  40.          }
  41.       },
  42.       {
  43.          "id":19156818,
  44.          "order_item_id":71126038,
  45.          "batch_job_id":9972081,
  46.          "series_number":1,
  47.          "series_total":1,
  48.          "order":{
  49.             "id":"POS-80DAF4",
  50.             "ref":"ADD14AE3630E28DA",
  51.             "external_ref":"POS-80DAF4",
  52.             "customer_name":"Test Testing",
  53.             "shipping_address_1":"Pinewood Court",
  54.             "shipping_address_2":"",
  55.             "shipping_address_3":"",
  56.             "shipping_address_4":"Macclesfield",
  57.             "shipping_address_5":"Cheshire",
  58.             "shipping_postcode":"SK10 2XR",
  59.             "shipping_country_code":"GB",
  60.             "shipping_carrier":"Hermes",
  61.             "shipping_method":""
  62.          },
  63.          "order_item":{
  64.             "id":71126038,
  65.             "type":2,
  66.             "mapped_sku":"SGS7E-CS-G-TEST",
  67.             "sku":"SGS7E-CS-G-TEST",
  68.             "description":"Samsung Galaxy 7 Edge Snap In Gloss",
  69.             "quantity":1,
  70.             "artwork":null
  71.          }
  72.       }
  73.    ]
  74. }

Example Consolidation Job Data

  2. {
  3.    "id":9972198,
  4.    "artwork":null,
  5.    "items":[
  6.       {
  7.          "id":19157068,
  8.          "order_item_id":71128134,
  9.          "batch_job_id":9972198,
  10.          "series_number":1,
  11.          "series_total":1,
  12.          "order":{
  13.             "id":"POS-BED9F4",
  14.             "ref":"24C1AC7E630E3314",
  15.             "external_ref":"POS-BED9F4",
  16.             "customer_name":"Test Testing",
  17.             "shipping_address_1":"Pinewood Court",
  18.             "shipping_address_2":"",
  19.             "shipping_address_3":"",
  20.             "shipping_address_4":"Macclesfield",
  21.             "shipping_address_5":"test",
  22.             "shipping_postcode":"SK10 2XR",
  23.             "shipping_country_code":"GB",
  24.             "shipping_carrier":"",
  25.             "shipping_method":""
  26.          },
  27.          "order_item":{
  28.             "id":71128134,
  29.             "type":2,
  30.             "mapped_sku":"JH001 HEA XL",
  31.             "sku":"Jh001-PSTEST",
  32.             "description":"AWDis Hooded Sweatshirt",
  33.             "quantity":1,
  34.             "artwork":[
  35.                {
  36.                   "name":"AV HD6 Black HQ_64021_Hoodies Full Size_71128134-output-3950663_1_16_129.png",
  37.                   "nameSansExt":"AV HD6 Black HQ_64021_Hoodies Full Size_71128134-output-3950663_1_16_129",
  38.                   "ext":"png",
  39.                   "description":"AV HD6 Black HQ_64021_Hoodies Full Size_71128134-output-3950663_1_16_129.png",
  40.                   "clientUrl":"https:\/\/s3-eu-west-1.amazonaws.com\/generated-assets-gateway3d-com\/auto-crop\/4f\/af\/93\/39\/59\/92\/1d\/7f\/6f\/e0\/e2\/14\/16\/81\/e7\/22\/95\/cf\/6b\/32\/a2\/c6\/06\/44\/6d\/c4\/75\/86\/fc\/d5\/e6\/5d.png",
  41.                   "isMergedMulti":false,
  42.                   "isMerged":false,
  43.                   "isMulti":false,
  44.                   "isSingle":false,
  45.                   "isThumbnail":false,
  46.                   "isUserPopulated":true
  47.                }
  48.             ]
  49.          }
  50.       },
  51.       {
  52.          "id":19157069,
  53.          "order_item_id":71128135,
  54.          "batch_job_id":9972198,
  55.          "series_number":1,
  56.          "series_total":1,
  57.          "order":{
  58.             "id":"POS-BED9F4",
  59.             "ref":"24C1AC7E630E3314",
  60.             "external_ref":"POS-BED9F4",
  61.             "customer_name":"Test Testing",
  62.             "shipping_address_1":"Pinewood Court",
  63.             "shipping_address_2":"",
  64.             "shipping_address_3":"",
  65.             "shipping_address_4":"Macclesfield",
  66.             "shipping_address_5":"test",
  67.             "shipping_postcode":"SK10 2XR",
  68.             "shipping_country_code":"GB",
  69.             "shipping_carrier":"",
  70.             "shipping_method":""
  71.          },
  72.          "order_item":{
  73.             "id":71128135,
  74.             "type":2,
  75.             "mapped_sku":"JH001 GOL M",
  76.             "sku":"JH001 GOL M",
  77.             "description":"AWDis Hooded Sweatshirt",
  78.             "quantity":1,
  79.             "artwork":[
  80.                {
  81.                   "name":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116.png",
  82.                   "nameSansExt":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116",
  83.                   "ext":"png",
  84.                   "description":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116.png",
  85.                   "clientUrl":"https:\/\/s3-eu-west-1.amazonaws.com\/generated-assets-gateway3d-com\/auto-crop\/94\/ab\/92\/cf\/57\/69\/3e\/a9\/69\/72\/45\/41\/ba\/47\/c7\/05\/98\/4c\/24\/0f\/97\/5b\/d9\/64\/6c\/04\/3e\/91\/8b\/35\/72\/6f.png",
  86.                   "isMergedMulti":false,
  87.                   "isMerged":false,
  88.                   "isMulti":false,
  89.                   "isSingle":false,
  90.                   "isThumbnail":false,
  91.                   "isUserPopulated":true
  92.                }
  93.             ]
  94.          }
  95.       }
  96.    ]
  97. }

Kornit Naming Convention

For consolidation jobs, it's possible for the integration to push filenames that identify the Kornit set up, table and X and Y offsets.

To enable this, enable the Kornit Quick P RIP integration on the same production centre that the Generic API production integration was set up on.

Details on the Kornit Quick P RIP integration can be found here.

As you can see from the example data below, a URL to the artwork is provided, along with the name required by Quick P to apply the correct set up for the item.

  2. "artwork":[
  3.                {
  4.                   "name":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116.png",
  5.                   "nameSansExt":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116",
  6.                   "ext":"png",
  7.                   "description":"AV HD6 Black HQ_64021_Hoodies Full Size_71128135-output-3950663_1_14_116.png",
  8.                   "clientUrl":"https:\/\/s3-eu-west-1.amazonaws.com\/generated-assets-gateway3d-com\/auto-crop\/94\/ab\/92\/cf\/57\/69\/3e\/a9\/69\/72\/45\/41\/ba\/47\/c7\/05\/98\/4c\/24\/0f\/97\/5b\/d9\/64\/6c\/04\/3e\/91\/8b\/35\/72\/6f.png",
  9.                   "isMergedMulti":false,
  10.                   "isMerged":false,
  11.                   "isMulti":false,
  12.                   "isSingle":false,
  13.                   "isThumbnail":false,
  14.                   "isUserPopulated":true
  15.                }
  16.             ]

The artwork can be downloaded from the clientURL field and saved using the artwork "name" field as the filename.

    • Related Articles

    • Product Integration | Generic API

      Introduction This article has been created to show how to setup the Product integration Kornit X has built to connect to Generic API.  Setup To setup the Generic API integration, please head to your category and within and within the advanced ...

    • Notification Integration | Generic Filesystem

      Introduction This article has been created to show how to setup the Notification Integration that Kornit X has built to connect to a Generic Filesystem  Setup To setup the Generic Filesystem Notification integration, please head to your company and ...

    • Shipper Integration | Generic Label

      Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to a Generic Label. Setup To setup the Generic Label integration, please head to your company and within the advanced settings ...

    • Production Integration: Generic Hot folder

      This production integration gives the ability to pass artwork from batches to a hot folder. The artwork will be added as default into a folder called 'artwork' within a folder determined by the batch name. The 'Generic Hotfolder' integration can be ...

    • Supplier Integration | Generic API

      The Order Push API from Custom Gateway us our generic OMS API allowing us to POST order data in JSON format (matching the structure of our standard orders in API) to an endpoint nominated by a supplier. This is a cheaper alternative to Custom Gateway ...