Skip to main content
POST
Test a connector

Authorizations

Authorization
string
header
required

A secret key from Print.App admin → Domains → Secret keys, sent as Authorization: Bearer sk_…. Server-side only.

Body

application/json

A connector to play against a design: a saved one (connectorId) or one to try before saving (connector).

designId
string
required

The design it is (or will be) attached to.

Required string length: 1 - 200
connectorId
string

A saved connector.

Required string length: 1 - 100
connector
object

A connector to try without saving it, as POST /v2/connectors takes it.

url
string<uri>

The product page, to read the field and its choices from it. A page of your store only.

Maximum string length: 2000
values
(string | object)[]

The choices to play, when there is no page to read them from (or to play others than the page has): a value, or { value, label } for a choice whose label differs.

Maximum array length: 100
Maximum string length: 200

Response

OK.

What a connector does for each choice, and what stands in its way.

object
string
required
Allowed value: "connector_test"
ok
boolean
required

Every choice does what it should and nothing blocks it.

connector
Connector · object
required

Links an option on a store's product page to the editor: the choice a customer makes shows the right pages, opens the right design, sets the size or the colour.

Example:
design
object
required
page
null | object
required
results
object[]
required

One per choice played (pageCount and printedPageCount: one per page count).

issues
object[]
required