# FavCRM Public SDK Docs

> Public v6 customer-portal API documentation for building storefront, booking, member-portal, CMS, event, commerce, loyalty, and survey integrations against FavCRM.

Site: https://docs.favcrm.io
API base: https://api.favcrm.io
Legacy proxy: https://api.favoredapp.co
Locales: English (/), Traditional Chinese (/zh-hant/)

## Canonical Files

- [OpenAPI YAML](https://docs.favcrm.io/openapi/connect-v6.openapi.yaml): curated public SDK contract (OpenAPI 3.1.0).
- [LLM full context](https://docs.favcrm.io/llms-full.txt): single-file bundle of every doc + OpenAPI + JSON examples.
- [Connect API Guide](https://docs.favcrm.io/docs/connect-api.md): overview, auth, legacy mapping, and endpoint groups.
- [Booking Flows](https://docs.favcrm.io/docs/booking-flows.md): services, slots, guest booking, and customer booking records.
- [Event Flows](https://docs.favcrm.io/docs/event-flows.md): public events and event registration flows.
- [CMS Flows](https://docs.favcrm.io/docs/cms-flows.md): pages, posts, categories, menus, and content reads.
- [Member Flows](https://docs.favcrm.io/docs/member-flows.md): registration, OTP login, token validation, and refresh.

## JSON Examples

- [Create guest booking](https://docs.favcrm.io/examples/create-guest-booking.json)
- [Register member](https://docs.favcrm.io/examples/register-member.json)
- [List booking records](https://docs.favcrm.io/examples/list-booking-records.json)

## Important Context

- All public SDK routes are under `/v6/customer-portal`.
- Public tenant routes require `X-Company-Id: cmp_*` or storefront-domain resolution.
- Customer-scoped routes require `Authorization: Bearer <customer-token>` (JWT from OTP verify, register, or refresh).
- Magic-token routes are for signed-link or invitation flows only — token is single-use.
- All responses use the `{ success, data, meta }` envelope; lists nest items under `data.items` with optional pagination.
- Provider callbacks, MCP/OAuth discovery, health checks, generated platform docs, and internal developer routes are intentionally excluded from this SDK.
- Legacy `/connect/v1` behavior is documented only as migration guidance.

## When to Read What

- Building from scratch: start with `connect-api.md`, then read the flow doc closest to your use case.
- Need exact schemas / response shapes: load `openapi/connect-v6.openapi.yaml`.
- Need everything in one shot for an agent context: load `llms-full.txt`.