ConneoPrint Uploader

ConneoPrint API

The ConneoPrint API enables you to integrate our upload functionality into your webshop or system. With a simple REST API, you can manage sessions, upload files, and generate print-ready PDFs.

Getting Started

To get started with the ConneoPrint API you need:

  1. Authentication credentials: Contact us for a trial license
  2. Base URL: Contact us for this information
  3. SSL: All API calls must be via HTTPS

Authentication

Authorization: YOUR_API_KEY  (only in combination with the parameter :conneoId)

Workflow

  1. Create session: Start a new upload session with product specifications
  2. Upload files: Upload files via the web interface
  3. Check upload session: Verify all files are uploaded correctly
  4. Get preview: Retrieve preview images for your webshop
  5. Generate production file(s): Generate print-ready files when customer confirms

Error Handling

The API returns standard HTTP status codes:

  • 200 - Success
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (invalid API key)
  • 404 - Not Found (session does not exist)
  • 500 - Internal Server Error
⚙️

Customize the Upload Interface

  • Complete UI Control: Show or hide any UI element including toolbox buttons, sidebars, and quality indicators
  • Custom Text & Tooltips: Override default text and tooltips with your own content
  • Granular Configuration: Control every aspect from upload functionality to individual button visibility
  • Easy Integration: JSON-based configuration that works seamlessly with session creation

Need to customize the upload interface for your users? Configure which UI elements are shown or hidden, customize tooltips, and control the entire user experience.

🔧 View UI Configuration Guide →

Create Session

POST /api/:conneoId/sessions New Upload ▶

Parameters

productSize.width
number
width parameter
productSize.height
number
height parameter
bleed.left
number
left parameter
bleed.right
number
right parameter
bleed.top
number
top parameter
bleed.bottom
number
bottom parameter
sidesCount
number
sidesCount parameter
quantity
number
quantity parameter
myId
number
myId parameter
conneoId
string
conneoId parameter
fileUrl
string
fileUrl parameter
options.showBleedMarker
boolean
showBleedMarker parameter
options.minimalDpi
number
minimalDpi parameter
options.variantsConfig.maxCount
number
maxCount parameter
options.variantsConfig.needsExactCount
boolean
needsExactCount parameter

Request Body

{ "productSize": { "width": 1050, "height": 700 }, "bleed": { "left": 20, "right": 20, "top": 20, "bottom": 20 }, "sidesCount": 2, "quantity": 10, "myId": 2, "conneoId": "<your conneoId>", "fileUrl": "<optional url to PDF file to preload in the upload session>", "options": { "showBleedMarker": true, "minimalDpi": 72, "variantsConfig": { "maxCount": 5, "needsExactCount": false } } }

Check upload session

POST /api/:conneoId/sessions/:sessionId/confirm Confirm ▶

Parameters

confirmed
boolean
confirmed parameter

Request Body

{ "confirmed": true }

Get previews

GET /api/:conneoId/:sessionId/products Products ▶

Parameters

production
query

Generate production files

POST /api/:conneoId/:sessionId/production-files production-files ▶

Parameters

options.productionBleed
number
productionBleed parameter
options.description
string
description parameter
options.disableCutMarks
boolean
disableCutMarks parameter

Request Body

{ "options": { "productionBleed": 10, "description": "Order number 1234", "disableCutMarks": false } }
GET /api/:conneoId/:sessionId/assets Assets (uploaded files) ▶

Request Body

{}

Products & Variants Management

POST /api/:conneoId/:sessionId/products Add Product (Create Variant) ▶
PUT /api/:conneoId/:sessionId/products/:productId Update Product Count ▶

Parameters

count
number
count parameter

Request Body

{ "count": 3 }
DELETE /api/:conneoId/:sessionId/products/:productId Delete Product (Remove Variant) ▶