Skip to main content
The Consumer API powers end-user participation in Fanfare experiences: reading experience details, routing the consumer to the right access path, passing public gates, entering an experience, and taking state-gated actions for queues, draws, appointments, auctions, waitlists, and timed releases. Use this section when you are integrating a customer-facing application with Fanfare directly. The endpoint reference is generated from the service OpenAPI specification and filtered to the public integration surface.

Base URLs

EnvironmentBase URL
Productionhttps://consumer.fanfare.io/api
Local developmentUse the local URL from your service configuration

Authentication

Consumer API calls use the authentication flow appropriate for your integration path, such as publishable-key initialization, consumer sessions, or server-side calls. Keep secret credentials on your server and use the SDK guidance for browser-facing integrations.

Common Areas

  • Consumer authentication and session refresh
  • Experience lookup and journey-first routing
  • Public routing outcomes: routed, gated, and no_access
  • Public gates such as authentication, access code, and verification challenges
  • Queue, draw, auction, waitlist, appointment, and timed-release participation through the current state
  • State-gated actions exposed by the current journey view
  • Organization configuration needed by client integrations
Consumer-facing integrations should render the current public journey state and only show actions that are available in that state. Do not infer private eligibility or enforcement details from endpoint names. For request and response schemas, use the generated endpoint pages in this section.