Partner API
Live Partner RFQ create/read plus fail-closed estimate and order boundaries.
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. This is a dry-run first, public-safe boundary with no public-current RFQ, quote, order, or webhook claim for Master Data data products before external GA approval.
Partner RFQ create, owned-RFQ read, and owned-RFQ quote read are live. Estimate, quote acceptance, order, and batch-order capabilities remain fail-closed launch boundaries. Authentication, authorization, quota, catalog, and canonical RFQ validation still apply before any write.
What it is for
Use the Partner API when you need to:
- create an RFQ against an explicit published catalog product and Marketplace category group
- read one RFQ owned by your organization and its supplier quotes
- validate authentication, permissions, quota, and fail-closed integration handling
- prepare for estimate and order adapters while those capabilities remain disabled with
503 - connect downstream systems through signed webhooks
Typical flow
Send a bearer request to a published route and handle 401, 403, and authentication-authority
503 problem details.
Send catalogProductUid, category, title, quantity, and delivery city. A ready, authorized
product reaches the canonical RFQ pipeline; unavailable catalog context returns 503 PARTNER_RFQ_CATALOG_CONTEXT_UNAVAILABLE without consuming quota.
Estimate and order routes are also published as disabled boundaries; they do not return pricing or order records until canonical adapters exist.
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
Getting Started
Request access, create a key, import the spec, and send a first request.
Quickstart
Short hands-on path for a live RFQ plus fail-closed estimate handling.
Authentication
Bearer keys, security practices, permissions, and disabled-capability behavior.
Endpoints
High-level endpoint map for live RFQ, disabled estimate/order, and 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.
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 ->
هل كانت هذه المقالة مفيدة؟
مقالات ذات صلة
Last updated on