What Is partners-api?

Start With The Idea

Use this guide when a route, request, response, permission model, integration, or deployment behavior needs to be understood before people rely on it. In this guide, What Is partners-api? narrows that work to plain-language foundation for the platform API and where it fits in the Furries PH system. Because this is a foundations page, read it as part of the Platform adoption learning path rather than as an isolated checklist.

An API is a contract between systems. Even technical changes can affect attendee records, dashboard behavior, notifications, payments, files, or staff tools. Read the page for the decision it helps a person make, then use the steps and checks as a steady path from context to action to proof.

What This Page Explains

This is the concept layer. Read it before trying to operate the workflow so the later steps make sense in ordinary language first. The intended readers are partner administrators, event leads, adoption leads, and integration owners. If the guide names a dashboard screen, service area, export, or record type, treat that name as a pointer to real operational responsibility.

• Primary surface or service: partners-api.
• Records or contracts involved: API service expectations, Auth state, and Platform records.
• Main care point: Watch for using a service route with the wrong actor, changing a response another app depends on, leaking a secret, or triggering the same side effect twice.
• Proof worth keeping: route inventory, method and path, auth model, request and response shape, platform owner confirmation, test result, consumer note, and deployment evidence.

How The Idea Builds Toward Action

1. Say the idea in ordinary words: Begin by naming the Platform adoption situation, the owner, and the exact item involved in What Is partners-api?
2. Connect the idea to one real screen or source: Use partners-api to connect the words on the page to the screen, file, route, or service trail that people actually use.
3. Name what could change for people or records: Keep API service expectations, Auth state, and Platform records in view so the work stays tied to the records or contracts it can affect.
4. Choose the next practical guide from the related links: Before handing off, save proof such as route inventory, method and path, auth model, request and response shape, platform owner confirmation, test result, consumer note, and deployment evidence so an adoption lead and a non-specialist reviewer can understand what the route does and how it was verified.

You Are Ready To Continue When

You are ready to use the rest of this page when the purpose, owner, affected information, and proof are all clear enough for a second person to review.

1. Scope is named: The work is tied to the correct page, event, report, route, file, person, or record.
2. Impact is understood: The operator can explain the effect on callers, records, permissions, secrets, side effects, and downstream apps.
3. Proof is findable: The handoff points to evidence that an adoption lead and a non-specialist reviewer can understand what the route does and how it was verified.

End-to-end adoption runbook

1. Step 1 - Name the API workflow and owner: Identify the product area, organization owner, service path, and relying team before adopting a workflow or integration.
2. Step 2 - Read the contract in human terms: Check who can use it, what information is exchanged, what can fail, what records change, and what proof the adopting team must keep.
3. Step 3 - Prepare auth and input deliberately: Confirm the right role, account, partner, event, and approved data before depending on the workflow.
4. Step 4 - Use or request the route in the right environment: Use the approved dashboard, rego, LAN, or integration environment and keep credentials out of notes, screenshots, and exports.
5. Step 5 - Check returned data and real side effects: Confirm the visible result, affected records, external action, and review evidence in plain language.
6. Step 6 - Record tests, docs, and handoff notes: Record the owner, expected behavior, adoption evidence, and escalation path before relying on it in production.

Explanation

partners-api is the Cloudflare Worker API layer used by partner dashboard tools, rego attendee flows, Event Management, EMS LAN support, webhooks, and selected public surfaces. It uses Hono service areas under src/routes and mounts them from src/index.ts.

Question list

1. Question 1 - Who is the caller? Identify whether the request comes from partner dashboard, rego, EMS LAN, a webhook, a public form, or an internal test tool.
2. Question 2 - What records can change? Check whether the route touches attendees, staff, events, payments, reports, files, or integrations.
3. Question 3 - What side effects can happen? Look for email, Discord, Telegram, Google Wallet, Sanity, deployment hooks, GitHub releases, or database writes.
4. Question 4 - What breaks if it changes? Search dashboard, rego, LAN, and docs consumers before changing payloads or status codes.

Checkpoints

1. Checkpoint 1 - Mounted route found: The endpoint exists in Capability Route Inventory.
2. Checkpoint 2 - Auth model known: The route has an confirmed auth model, not just an assumption from its folder.
3. Checkpoint 3 - Consumer known: At least one consumer or intended caller is documented.
4. Checkpoint 4 - Failure behavior known: The caller can safely handle expected errors.