API Reference
Map the Partner API, XJDF and PrintTalk layer, and Preflight surface to their canonical contracts, auth model, and integration guides.
API Reference
NowToPrint exposes three primary integration surfaces. Pick the surface that matches your workflow, then anchor your implementation to the published contract and guide for that surface.
API Surfaces
Partner REST API
Generated endpoint reference for estimates and launch-disabled RFQ create/list operations.
XJDF / PrintTalk
Generated readiness reference for XJDF, PrintTalk, and XJMF interoperability.
Preflight Engine
Generated queued PDF validation reference for job submission, status polling, and reports.
Canonical model guide
The transport contracts describe request and response formats. For the shared media, device, supplier or source, and job snapshot semantics behind XJDF, use the master-data guide.
Published Contracts & Generated Reference
| Surface | Current route family | Public contract | Generated reference | Integration guide |
|---|---|---|---|---|
| Partner API | https://api.nowtoprint.com/api/v1 | /docs/api/openapi.yaml | Partner REST API | Getting started |
| XJDF / PrintTalk | https://api.nowtoprint.com/api/v1/xjdf | /docs/api/xjdf-openapi.yaml | XJDF & PrintTalk API | Swagger preview |
| Preflight Engine | https://api.nowtoprint.com/api/v1 | /docs/api/preflight-openapi.yaml | Preflight Engine API | OpenAPI Explorer |
OpenAPI-first integration
For client generation, 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-product specs stay out of the public mirror. New integrations should anchor to the public
URLs above.
Partner RFQ launch posture
Partner RFQ routes are Launch-disabled and return 501 in the current public Partner API
contract. Quote and order flow stays outside the public Partner OpenAPI until the private-beta
evidence and onboarding controls are complete.
Authentication
Partner API
Use Authorization: Bearer <ntp_test_* or ntp_live_* key> for all Partner API requests.
GET /api/v1/rfq HTTP/1.1
Host: api.nowtoprint.com
Authorization: Bearer ntp_live_xxxxxxxxxxxxxxxxxxxx
Accept: application/jsonXJDF / PrintTalk
The XJDF / PrintTalk surface is a private-beta readiness reference. It supports bearer auth or
X-API-Key, and some enterprise postures may also use mTLS. Treat the integration contract and
onboarding agreement as the final authority; do not treat the public spec as CIP4 certification,
legal conformance, or external GA evidence.
Preflight Engine
Use bearer auth for queued PDF inspection requests submitted to the v1 preflight surface.
Operational posture
| Surface | What to expect | What to trust |
|---|---|---|
| Partner API | Entitlement-based access, quotas, and rollout state | Dashboard state plus response headers |
| XJDF / PrintTalk | Partner-specific readiness and capability negotiation | Contract posture, guide details, and 429 behavior |
| Preflight Engine | Workload-aware throttling and async processing | Queue response semantics and retry guidance |
When a limit is hit, the API returns 429 Too Many Requests. Respect Retry-After and keep write
operations idempotent.
Versioning policy
- Partner API is currently published on
v1 - XJDF and PrintTalk are exposed through the private-beta readiness
v1integration layer - Preflight is published on the current
v3surface - Breaking changes are introduced in a new major route family
- Deprecation notice is communicated before older majors are retired
Repository examples
Use docs/api/examples/
for integration snippets and reference payloads. Treat the published OpenAPI contracts as the
source of truth when examples and implementation drift.
Related Guides
هل كانت هذه المقالة مفيدة؟
مقالات ذات صلة
Last updated on
Developer Hub
Technical resources for integrating NowToPrint with public API guides, webhook delivery, XJDF workflows, and machine-readable specs.
Create RFQ (launch-disabled) POST
Launch-disabled until the canonical L5 catalog/RFQ resolver is enabled. The route authenticates and checks permissions, then returns 501 instead of creating mock RFQs.