docs(api) | add Partner API Explorer and documentation SPW-20190 - #12
docs(api) | add Partner API Explorer and documentation SPW-20190#12amir-faghihi wants to merge 7 commits into
Conversation
| - `reused_existing`: the partner identity already existed. | ||
| - `email_auto_linked`: the request was linked to an existing Showpass user after the partner confirmed the email. | ||
|
|
||
| Business conflicts such as an inactive identity, an email conflict, an invalid |
There was a problem hiding this comment.
This status description is too ambiguous for an integration client: invalid venue is grouped into 409 or 403 according to the failure boundary. Can we document the exact contract, with validation errors as 400, authentication or scope denial as 403, and 409 reserved for actual identity or resource conflicts?
| | --- | --- | --- | | ||
| | `POST` | [`/api/partner/users/`](/api/partner-api-users) | Create or reuse a partner user identity. | | ||
| | `POST` | [`/api/partner/customer-attribution-token/`](/api/partner-api-customer-attribution-token) | Issue a short-lived customer attribution token for an existing partner identity. | | ||
| | `POST` | [`/api/partner/orders/manage-link/`](/api/partner-api-order-manage-link) | Create a short-lived order-management handoff link for an order. | |
There was a problem hiding this comment.
The endpoint catalog stops at POST /api/partner/orders/manage-link/, but the returned URL points to GET /account/partner-login/<code>/. That browser consume route is part of the integration contract and controls one-time use, expiry, order-scoped session, and redirect behavior. Can we document it alongside the POST endpoint and state the expired or replayed-link behavior?
Functional Changes
Local QA sign-off
Not applicable by Amir. This is a documentation and docs UI change.
What is the change?
Why the change is important?
How to test?
npm run buildnpm run test:linksDatabase Migrations
No database migrations.
Additional Notes