Getting Started
Using the API from Dashboard Code
How dashboard developers should call partners-api from UI features.
First created Last updated
End-to-end developer runbook
- Step 1 - Confirm the API area: Identify the product area, route module, endpoint path, and consumer before writing or calling code.
- Step 2 - Read the endpoint contract: Check method, auth, parameters, response, errors, side effects, and related docs.
- Step 3 - Prepare authentication and input: Use the right session, bearer token, webhook secret, or internal header. Validate body and query data before sending it.
- Step 4 - Make the request: Call the endpoint from the correct origin and environment. Keep credentials and secrets out of logs.
- Step 5 - Verify response, side effects, and records: Confirm status code, response shape, database records, external side effects, and audit evidence.
- Step 6 - Add tests, docs, and handoff notes: Update route inventory, consumer notes, and certification checks before depending on the change.
Dashboard call pattern
- Action 1 - Resolve API base from existing dashboard helpers: Follow existing dashboard client utilities instead of hardcoding production origins.
- Action 2 - Include credentials when cookie auth is required: Most dashboard routes need the partner session.
- Action 3 - Use route-specific payloads: Do not reuse generic row mutation helpers for product routes unless the docs say the route is generic.
- Action 4 - Show operator-safe errors: Convert API errors into clear UI messages without exposing secrets or raw stack traces.
- Action 5 - Verify record impact: After mutation, reload or reconcile the affected dashboard surface.