Security
Data Privacy and Auditability
How API developers should protect sensitive records and preserve proof of changes.
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.
Data classes
- Action 1 - Identify sensitive records: Attendee identity, registration, payment, staff, volunteer, report, ban, social-link, media, and event operation records.
- Action 2 - Limit fields: Return only what the caller needs for the workflow.
- Action 3 - Preserve actor evidence: Mutations should retain who changed the record and why when the domain requires accountability.
- Action 4 - Keep side effects traceable: Email, Discord, Telegram, Google Wallet, and deployment side effects need enough evidence for support and incident review.