Platform API Glossary

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.

Terms

1. Actor: The person or system making the request.
2. Auth family: The type of authentication used, such as dashboard auth, rego auth, webhook secret, or internal secret.
3. Binding: A Cloudflare Worker environment variable, secret, KV namespace, or integration setting.
4. Contract: The method, path, auth, inputs, outputs, errors, side effects, and stability expectations of an endpoint.
5. Consumer: The app or system calling the API, such as partner dashboard, rego, EMS LAN, a webhook sender, or an internal test tool.
6. Endpoint: One HTTP method on one path.
7. Route family: A group of endpoints owned by the same product area.
8. Side effect: A change outside the immediate response, such as database writes, email, social sync, wallet changes, uploads, or deploy hooks.
9. Unknown from source: A generated field that needs manual handler review before developers rely on it.