API Reference
Map the Partner API, XJDF and PrintTalk layer, and Preflight surface to their canonical contracts, auth model, and integration guides.
The current RFQ create and organization-owned RFQ/quote read contract is generated at /api/v1/marketplace/openapi.json. The older /docs/api/openapi.yaml publication is a separate reference; do not assume the documents are identical. Confirm the environment origin and approved capabilities during onboarding.
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
Current RFQ create/owned reads and disabled estimate/order boundaries.
XJDF / PrintTalk
Generated readiness reference for XJDF, PrintTalk, and XJMF interoperability.
Preflight Engine
OpenAPI contract for queued PDF validation, status polling, and reports. Spec only — no reference page yet.
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 | /api/v1/marketplace/openapi.json | 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 | Spec only — no reference page yet | 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, and future external-product specs stay out of the public
mirror. New integrations should anchor to the public URLs above.
Partner capability posture
Partner RFQ create, owned detail, and owned quote reads are live. Estimate, quote acceptance, order, and batch-order routes remain Launch-disabled (HTTP 503). RFQ writes still fail closed when auth, quota, catalog context, L2 product, or Marketplace group validation fails.
Quote and order flow boundaries
Order and batch capabilities are launch-disabled and remain fail-closed boundaries. They return
PARTNER_ORDER_CAPABILITY_UNAVAILABLE or PARTNER_BATCH_ORDER_CAPABILITY_UNAVAILABLE
with RFC 9457 503 after auth and permission checks. No order or batch item is created, listed, or
attempted; these non-public routes are not advertised here or in the public Partner OpenAPI.
Authentication
Partner API
Use Authorization: Bearer <ntp_partner_v2_ credential> for all Partner API requests.
GET /api/v1/rfq?id=rfq_example HTTP/1.1
Host: api.nowtoprint.com
Authorization: Bearer ntp_partner_v2_<issued-key-id>_<secret>
Accept: application/json
XJDF / PrintTalk
Public XJDF discovery, capabilities and validation metadata require no API key. Costing requires an authenticated organization session and server-resolved L4 authority. XJMF callbacks require sender-registry HMAC and timestamp headers. A static spec does not establish CIP4 certification or external GA.
Preflight Engine
Queued v1 preflight uses its separate server bearer credential and paid server-work grant, not the Partner V2 key. Only controlled configured storage URLs are accepted; use the preflight guide below for payload boundaries.
Operational posture
| Surface | What to expect | What to trust |
|---|---|---|
| Partner API | Entitlement-based access, quotas, and rollout state | Credential decision, problem resetAt, approved rollout |
| 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. Honor Retry-After when provided and follow each route’s retry identity; Partner credential quota returns resetAt in the body.
Versioning policy
Partner RFQ operations are published under the generated marketplace-partner-api.v1 contract. Public XJDF metadata and the queued preflight route use /api/v1 paths; a spec's package version does not establish a public /v3 route. Check the exact operation and deployment agreement before generating or upgrading a client. Static publications can lag implementation; reconcile differences before relying on them.
Repository examples
Use docs/api/examples/
for integration snippets and reference payloads. Compare examples, the generated current contract and the route implementation; resolve drift before generating production clients.
Related Guides
Partner REST API Reference
Partner API Quickstart
Authentication
Webhook Access & Delivery
XJDF Integration Guide
XJDF Master Data Model
For queued preflight details and publication/runtime differences, read OpenAPI Explorer.
هل كانت هذه المقالة مفيدة؟