OpenAPI Explorer & Spec Reference
Download the published machine-readable contracts for the Partner API, XJDF and PrintTalk layer, and Preflight surface.
OpenAPI Explorer & Spec Reference
Use this page as the single public index for NowToPrint machine-readable contracts. Each surface has one canonical download URL and a matching guide for operational context.
Published Resources
| Resource | Public URL | Generated reference | Best for |
|---|---|---|---|
| Partner REST API contract | /docs/api/openapi.yaml | Partner REST API | Postman import, SDK generation, and QA contract review |
| XJDF / PrintTalk readiness contract | /docs/api/xjdf-openapi.yaml | XJDF & PrintTalk API | Private-beta readiness review and capability tooling |
| Preflight Engine contract | /docs/api/preflight-openapi.yaml | Preflight Engine API | Queued PDF inspection clients for job submission and polling |
| XJDF Swagger preview | /docs/api/swagger-ui.html | XJDF integration guide | Browser-based inspection of the XJDF contract |
Canonical publication flow
Only allowlisted public specs are published at the public /docs/api/* URLs during verification
and build. Internal Master Data contracts, admin routes, dark private-beta data-product contracts,
Master Data-backed XJDF bridge routes, and future external-productization specs stay out of the
public mirror. Treat the public URLs on this page as the integration entry point.
Partner REST API
Overview
The Partner API public contract currently covers estimates plus launch-disabled RFQ create/list operations. Quote acceptance, orders, and external Master Data data products are not public contract surfaces yet.
- Base URL:
https://api.nowtoprint.com/api/v1 - Authentication:
Authorization: Bearer <ntp_test_* or ntp_live_* key> - Best for: estimates, RFQ launch-readiness checks, and operational webhook preparation
First request
curl -X POST https://api.nowtoprint.com/api/v1/estimate \
-H "Authorization: Bearer ntp_test_your_key" \
-H "Content-Type: application/json" \
-d '{
"category": "business_cards",
"quantity": 500,
"specifications": {
"paperType": "coated-matte"
}
}'
Next reading
XJDF / PrintTalk API
Overview
The XJDF and PrintTalk layer is a readiness-oriented private-beta contract for standards-referenced interoperability with MIS, ERP, and workflow systems. It is not a CIP4 certification, legal conformance claim, or external GA commitment.
- Route family:
https://api.nowtoprint.com/api/v1/xjdf - Authentication: bearer auth or
X-API-Key, with mTLS in selected enterprise postures - Best for: readiness review, standards-referenced job exchange, capability discovery, and external workflow alignment
Master Data-backed XJDF bridge routes such as media catalog, master-data export, and devices remain internal-only and are intentionally absent from the public spec and public discovery response.
Explore in the browser
Use the published preview when you need a human-friendly contract walkthrough before importing the spec:
Preflight Engine API
Overview
The preflight surface is a queued validation contract for PDF inspection, job submission, and status polling.
- Route family:
https://api.nowtoprint.com/api/v1 - Authentication: bearer token
- Best for: automated file validation, technical quality checks, and asynchronous analysis
Sample request
POST /api/v1/preflight HTTP/1.1
Host: api.nowtoprint.com
Authorization: Bearer ntp_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"fileUrl": "https://cdn.example.com/artwork.pdf",
"profile": "print_ready"
}
Sample response shape
{
"jobId": "pref_01js3q7d9w4b2k8m1z0h3v6x7y",
"status": "queued",
"submittedAt": "2026-04-16T10:00:00.000Z",
"links": {
"self": "/api/v1/preflight/pref_01js3q7d9w4b2k8m1z0h3v6x7y"
}
}
Generated reference
Problem details and retries
NowToPrint surfaces integration failures through structured HTTP responses. In general:
400means payload or schema mismatch401means missing or invalid credentials403means scope or entitlement mismatch429means back off and trustRetry-After5xxmeans transient failure or dependency disruption
Use request IDs in logs, keep write operations idempotent, and wire webhooks before production.
Change management
- Partner API public contract:
v1 - XJDF integration layer: private-beta readiness
v1 - Preflight surface: current public
v3 - New major route families are used for breaking changes
- Public contract files are updated before external integration guidance changes
Related: API Reference | Partner API | XJDF API | Webhook Access & Delivery
Was this article helpful?
Related articles
Last updated on