Partner API
Commercial API surface for estimates and launch-disabled RFQ preparation.
Partner API
Master Data external-dark
Master Data data-product APIs are runtime-dark for external partners. The current path is internal pre-live/private-beta only. Partner API does not expose Master Data canonical write authority, private evidence, supplier rates, cost, margin, or payout fields until the future external-productization controls are live.
The public Partner API currently exposes the published estimate contract and launch-disabled RFQ create/list operations. Quote acceptance, orders, and external Master Data data products are not part of the public Partner API contract yet.
What it is for
Use the Partner API when you need to:
- price print products from your own product or portal
- prepare for RFQ integration while
/api/v1/rfqremains launch-disabled with501 - connect downstream systems through signed webhooks
Typical flow
Use POST /api/v1/estimate to validate payload shape and pricing posture before opening a
future RFQ flow.
POST /api/v1/rfq authenticates and checks permission, then returns 501 until the canonical
L5 catalog/RFQ resolver is enabled.
Quote acceptance and order creation stay future public-contract work until they appear in the published OpenAPI.
Access posture
Partner API access is entitlement-based. It is enabled through approval, rollout state, and for deeper integrations, contract-led onboarding.
| Area | Current posture |
|---|---|
| Authentication | Bearer API keys with ntp_test_* and ntp_live_* prefixes |
| Limits | Governed by entitlement and rollout state |
| Webhooks | Enabled per organisation and event family |
| Production use | Requires approved access and production-ready server-side key handling |
Public resources
Generated API Reference
Fumadocs OpenAPI reference for public Partner API endpoints and schemas.
Getting Started
Request access, create a key, import the spec, and send a first request.
Quickstart
Short hands-on path for estimate plus RFQ launch-disabled handling.
Authentication
Bearer keys, security practices, permissions, and quota behavior.
Endpoints
High-level endpoint map for estimate, launch-disabled RFQ, and excluded future surfaces.
Examples
cURL, Node.js, Python, and webhook verification snippets.
Webhooks
Signed delivery, retry posture, and payload handling guidance.
Canonical contract
The public Partner API contract is published at /docs/api/openapi.yaml.
Treat this file as the machine-readable source of truth for public client generation and contract review.
Internal Master Data, admin-only, dark private-beta and future data-product routes are intentionally
excluded from this public contract.
For rendered endpoint docs, use Partner REST API Reference.
When not to use Partner API
- Use XJDF / PrintTalk when your source system is an MIS or ERP that needs standards-based exchange.
- Use the preflight surface described in OpenAPI Explorer when your main goal is queued PDF analysis rather than quote and order automation.
Next: Getting Started ->
Была ли эта статья полезной?
Похожие статьи
Последнее обновление