Furries PH Docs
Dashboard
Platform API docs

Start

Platform API Developer Docs

Developer documentation for partners-api routes, auth, contracts, workflows, security, and operations.

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.

What this section covers

The Platform API docs cover the Cloudflare Worker in partners-api: Hono route mounting, dashboard and rego auth, webhooks, route families, generated endpoint contracts, environment bindings, external integrations, testing, deployment, and maintenance.

Route families

  • Authentication: Dashboard auth, Supabase Auth hooks, access checks, session helpers, and permission discovery.
  • Access and Core Data: Generic data access helpers, profile records, uploads, image proxying, SPA contracts, and guarded test-run utilities.
  • Admin and Organization: Partner administration, organization settings, notices, Discord administration, and trust-safety enforcement records.
  • Registration and Attendees: Attendee registration, profiles, fursonas, reservations, waitlist, group registration, and affiliate rewards.
  • Event Management: Event configuration, conditions, activities, HR, communications, analytics, Dealers Den, check-in, inventory, and POS-adjacent operations.
  • Finance and Payments: Payment providers, account records, finance programs, settlement records, refunds, transfers, and upgrades.
  • Social and Integrations: Discord, Telegram, social account linking, state tokens, member tags, roles, and ZEP access.
  • EMS LAN Support: Hosted LAN release proxy behavior and release download support.
  • Webhooks and Contact: Public contact form, Auth hooks, and public waitlist entrypoints.

Action list

  1. Action 1 - Start with foundations: Read What Is partners-api? before calling a route.
  2. Action 2 - Find the route family: Open the relevant route reference page and verify source module ownership.
  3. Action 3 - Check the generated contract: Use Generated Route Inventory to find exact method, path, source line, auth scan, and contract fields.
  4. Action 4 - Confirm security: Review Permissions and Roles and Data Privacy and Auditability.
  5. Action 5 - Build with tests: Follow Add a New API Route or the product-specific workflow.
  6. Action 6 - Keep docs current: Regenerate inventory whenever partners-api/src/index.ts or src/routes/*.ts changes.

Current audit baseline

  • Route modules scanned: 61
  • Mounted route families: 69
  • Generated endpoint entries including aliases: 827
  • Source root: C:\Users\Workstation\Documents\Github\partners-api

All docs