Partner API Access Model
How Partner API access is enabled through package entitlements, rollout state, key registry controls, and contract onboarding.
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.
Partner API access is not a separate public self-serve pricing ladder. It is enabled through capability authorization, rollout state, key registry controls, and, for deeper integrations, contract-led onboarding.
Current access model
| Access state | Typical use | How it is enabled |
|---|---|---|
| Approved integration | Initial integrations and sandbox validation | Access request / onboarding approval |
| Private-beta pilot | Selected workflow automation and event delivery | Waitlist / pilot enablement |
| Enterprise contract | API-heavy integrations, governance, custom limits | Contract-led rollout |
Credential admission consumes a distributed per-credential, organization and scope bucket, with a
durable usage outbox in the same transaction. The default Partner v1 budget is 120 requests/minute
per scope. This happens before even a disabled estimate/order capability returns 503. RFQ create
also has a separate tier-based daily reservation after catalog readiness; an unavailable catalog
does not spend that daily allowance. No deployed quota/retention evidence is implied.
What determines access
- current organization capability and commercial policy
- active API capability
- key registry state and scopes
- rollout state
- contract posture, if applicable
API keys
API keys prove that a caller is known and scoped. They do not, by themselves, enable public GA traffic, RFQ creation, quote automation, order automation, webhook delivery, or Master Data data-product access. Those capabilities require explicit contract and rollout enablement.
Master Data
Master Data is internal-only for external partners unless a private-beta contract and rollout explicitly enable a sanitized read projection. External GA is not enabled. Public Partner API access does not currently include externally enabled Master Data data-product endpoints, partner reads, entitlement scopes, quotas, SLAs, onboarding controls, or canonical write authority.
Master Data external-dark
Contract-ready does not mean externally enabled. Keep Master Data partner reads dark until runtime auth, audit, quota, onboarding, legal controls, certification controls, and production evidence are complete. Public/partner payloads must stay sanitized and cannot leak private evidence, cost, margin, payout, supplier source, or rate-card fields.
FAQ
Can I just upgrade from a self-serve billing page?
Not always. Partner API access is usually enabled through approval, pilot, or contract workflow rather than a generic checkout flow.
Is Partner quota enforced?
Yes. Credential request quotas are enforced before capability handling, and successful RFQ admission also uses durable daily reservations. Handle both credential-rate and daily-RFQ 429 responses using their reset metadata. Do not confuse a commercial tier label with a purchasable public membership package.
Authentication calls consumeCredentialQuota; the bucket and credential_v2_usage_outbox are written in one Firestore transaction. Minute-bucket denial returns PARTNER_API_RATE_LIMITED. The daily RFQ allowance uses a separate reservation port; unavailable catalog context does not reach that daily reservation. Disabled estimate/order routes authenticate first and therefore still consume the minute bucket.
War dieser Artikel hilfreich?