API guide
For Shop+ shops and their web people. The API lets your own systems talk to Studio: pull in finished designs and print PDFs, send a customer a design link with their details and your order number already in it, and keep your product list in sync.
Not technical? You don't need this page. Send it to whoever runs your website or order software.
The basics
- Address: every request goes to
https://studio.inkorca.com/api/v1/… - Key: make one in your dashboard under API & web address. Send it on every request as a header:
Authorization: Bearer ios_…. Keep it secret, like a password, and use it only from your server, never in a web page. - Format: send and receive JSON (
Content-Type: application/json). - Errors: a non-2xx status with
{"error": "what went wrong"}. 401 = bad key, 402 = your account isn't active, 403 = not on Shop+, 404 = not found.
curl https://studio.inkorca.com/api/v1/shop \ -H "Authorization: Bearer ios_your_key_here"
Designs
A design is one finished product a customer sent you, with its print-ready PDF (bleed included, trim size set).
GET /api/v1/designs
Newest first. Optional filters: since (a date and time, for example 2026-11-01T00:00:00Z, to get only newer ones), status (new, in_progress or done), ref (your order number) and limit (1 to 200, default 50).
{
"designs": [{
"id": "K7Q2M9XD",
"group": null,
"ref": "ORDER-1042",
"status": "new",
"product": { "id": "business-cards-3f9a", "name": "Business cards", "size": "3.5 x 2 in" },
"customer": { "name": "Ana Ruiz", "email": "ana@example.com", "phone": "", "note": "500, matte" },
"pages": 2,
"warnings": [],
"source": "api",
"created": "2026-11-22T18:04:11.000Z",
"files": { "pdf": "https://studio.inkorca.com/f/K7Q2M9XD/…/print.pdf", "thumb": "…/thumb.jpg", "design": "…/design.json" }
}]
}
group ties together products a customer sent in one request. ref is your order number when the design came from a link you made with the API. File links are private and long-lived; download the PDF to keep it, because finished designs are kept for at least 60 days.
GET /api/v1/designs/{id}
One design, same fields as above.
PATCH /api/v1/designs/{id}
Change its status, so your dashboard matches your shop floor. Body: {"status": "in_progress"} (or new, done).
Customer design links
POST /api/v1/links
Makes a design link for one customer. When they open it, their name, email and phone are already filled in, and the design they send carries your order number (ref) in the email, your dashboard, the webhook and the API. Typical use: a customer pays for 500 cards on your website, your site calls this, and the customer gets "Design your cards" in their receipt.
curl -X POST https://studio.inkorca.com/api/v1/links \
-H "Authorization: Bearer ios_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"product": "business-cards-3f9a",
"ref": "ORDER-1042",
"customer": { "name": "Ana Ruiz", "email": "ana@example.com", "phone": "555-0100" },
"expires_days": 30
}'
{ "url": "https://studio.inkorca.com/d/your-shop?p=business-cards-3f9a&c=…", "expires": "2026-12-22T18:04:11.000Z", "ref": "ORDER-1042", "product": "business-cards-3f9a" }
Every field is optional. Leave out product to let the customer pick. expires_days is 1 to 90 (default 30). If you have your own web address, the link uses it.
Products
GET /api/v1/products
Your products with their codes (id), trim size in inches (w, h), bleed, safe margin, sides (1 or 2), dpi (paper, sign or banner), template family (kind) and active.
POST /api/v1/products
Add one. Body: {"name": "Rack card 4 x 9", "w": 4, "h": 9, "bleed": 0.125, "safe": 0.125, "sides": 2, "dpi": "paper", "kind": "flyers"}. Returns its new id. Sizes are 0.5 to 240 inches. Up to 200 products.
PUT /api/v1/products/{id}
Update one. Send the full product (same fields as adding), plus "active": false to hide it from customers.
DELETE /api/v1/products/{id}
Your account
GET /api/v1/shop
Your shop name, design link, your own web address (if live) and this month's design count.
Webhook
Instead of asking for new designs, you can have Studio tell you. Set a webhook address under Share in your dashboard (Pro and Shop+). For each finished design we POST:
{ "event": "design.created", "id": "K7Q2M9XD", "group": null, "ref": "ORDER-1042",
"product": { "id": "…", "name": "Business cards", "size": "3.5 x 2 in" },
"customer": { "name": "…", "email": "…", "phone": "…", "note": "…" },
"files": { "pdf": "…", "thumb": "…", "design": "…" }, "created": "…" }
Check it's really from us: the X-Studio-Signature header is the HMAC-SHA256 of the raw request body, using your signing secret (shown under the webhook box), written as base64url without padding.
// Node.js
const crypto = require("crypto");
const expected = crypto.createHmac("sha256", process.env.STUDIO_WEBHOOK_SECRET).update(rawBody).digest("base64url");
const ok = crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(req.headers["x-studio-signature"] || ""));
On Shop+ you can also simply call GET /api/v1/designs/{id} with the id from the webhook.
Your own web address
Shop+ can put the designer on an address of your own, like design.yourshop.com. In your dashboard under API & web address, follow the steps: add a CNAME record at your domain company pointing to the address shown there, then save your address. Once it's live, your design link, website button links and API links all work on it.
Limits
Please keep to about 2 requests a second. Designs made through API links count toward your monthly designs like any other.
Help
API help is by email only: info@inkorca.com. We answer questions about how the API and webhook work. We don't build, maintain or fix your own website, cart, code or integration, or third-party tools such as Zapier. For help setting up your side, please consult with your web administrator. See the Terms.