API Reference
API Reference
The three surfaces you integrate against — the GraphQL BFF, the ai-assist chat endpoint, and auth REST.
Surfaces
customerSAX exposes three API surfaces:
| Surface | Transport | Base | Purpose |
|---|---|---|---|
| GraphQL BFF | GraphQL (POST) | :4000/graphql | The federated supergraph — commerce + ticketing + admin |
ai-assist /chat | HTTP streaming (POST) | :8080/chat | The AI assistant chat stream |
| Auth REST | REST (JSON) | :4360 | Sessions and project selection |
Field names below are transcribed from the real contract allowlist and service code. This reference documents operations that exist; it does not invent fields. Where a shape is intentionally summarized, it says so.
Conventions
- Never call a subgraph directly. Always go through the BFF (
:4000). The subgraph ports are internal. - Headers. The BFF derives
x-csa-commerce-platform,x-csa-project-key,x-csa-client-id,x-csa-user-roleandx-csa-user-emailfrom the gateway context and forwards them to subgraphs. - Access control. Reads default open, writes default closed. Destructive operations are gated behind an approval step.