Furries PH Docs
Dashboard
Platform API docs

Testing

Local API Testing

How to test partners-api routes locally and safely.

First created Last updated

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.

Test flow

  1. Action 1 - Start with read routes: Confirm environment and auth before mutation tests.
  2. Action 2 - Use representative actor sessions: Dashboard and rego sessions must match the route family.
  3. Action 3 - Test negative cases: Missing auth, wrong event, bad body, missing required query, and forbidden role.
  4. Action 4 - Verify records after mutations: Check database state and external side-effect logs.
  5. Action 5 - Update route inventory: Contract docs should change with route behavior.

All docs