Making Your First Request

End-to-end developer runbook

1. Step 1 - Confirm the API area: Identify the product area, route module, endpoint path, and consumer before writing or calling code.
2. Step 2 - Read the endpoint contract: Check method, auth, parameters, response, errors, side effects, and related docs.
3. 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.
4. Step 4 - Make the request: Call the endpoint from the correct origin and environment. Keep credentials and secrets out of logs.
5. Step 5 - Verify response, side effects, and records: Confirm status code, response shape, database records, external side effects, and audit evidence.
6. Step 6 - Add tests, docs, and handoff notes: Update route inventory, consumer notes, and certification checks before depending on the change.

First request flow

1. Step 1 - Pick a read-only endpoint: Start with a GET route from the generated inventory.
2. Step 2 - Confirm the caller: Use dashboard credentials for partner routes or rego credentials for attendee routes.
3. Step 3 - Copy the generated example: Start from the route inventory curl or TypeScript example.
4. Step 4 - Add only proven inputs: Include path and query parameters that source code actually reads.
5. Step 5 - Inspect the full response: Save status, headers, and JSON shape.
6. Step 6 - Update docs if behavior differs: Source and rendered behavior are the authority.

Example

const response = await fetch(new URL('/api/example', apiBase), {
  method: 'GET',
  credentials: 'include',
});

if (!response.ok) {
  const error = await response.json().catch(() => ({ error: 'Unknown error' }));
  throw new Error(error.error ?? 'Request failed');
}