Introduction

Welcome to the Fanbase API documentation! This guide provides all the information needed to integrate your system with the Fanbase platform, including authentication, security, integrations, and services.

About the Fanbase Platform

Fanbase offers a complete identity management, integration, and services platform through multiple specialized APIs:

• Authentication: Single Sign-On (SSO) system based on OpenID Connect and OAuth 2.0
• Security: Security endpoints and identity management
• Connect: API for integrations, data processing, and export
• Fanmarket: Integration with delivery and e-commerce services

Environment URLs

The variables below are used throughout this documentation to represent the addresses of each environment and service:

Authentication (Login)

Production:

• {login-producao} = https://login.{seu-dominio}.com.br

Staging:

• {login-homologacao} = https://login-{seu-dominio}.fantest.com.br

Security (SSO)

Production:

• {security-producao} = https://security.fanbase.com.br

Staging:

• {security-homologacao} = https://security.fantest.com.br

Connect (Integrations)

Production:

• {connect-producao} = https://connect.fanbase.com.br

Staging:

• {connect-homologacao} = https://connect.fantest.com.br

Fanmarket

Production:

• {fanmarket-producao} = https://fanmarketapi.fanbase.com.br

Staging:

• {fanmarket-homologacao} = https://fanmarketapi.fantest.com.br

Available Services

Authentication

OpenID Connect-based authentication system that uses the Authorization Code Flow, offering:

• Enhanced security: tokens are not exposed to the user's browser
• Signature validation: all tokens are signed and can be validated
• Access control: granular permission management through scopes

View complete documentation →

Security (SSO)

Security and identity management API that offers:

• Access token retrieval (client_credentials)
• Basic user information retrieval (UserInfo)
• Full user profile access (Profile)

View complete documentation →

Connect

API for integrations and data processing that includes:

• Queue: Queue system for asynchronous processing (webhooks, validations, notifications)
• Integrations: Transaction processing and batch registrations
• Export: Data export from surveys and filters
• Applications: Event and mobile device registration

View complete documentation →

Fanmarket

Integration with delivery services through Melhor Envio:

• Freight calculation and management
• Integration with multiple carriers
• Delivery management and tracking

View complete documentation →

Authentication Flow

The system uses the Authorization Code Flow from OpenID Connect, which ensures security by not exposing tokens directly in the user's browser. The complete flow includes:

1. Authentication request to the login endpoint
2. User redirect to login
3. Receiving the authorization code
4. Exchanging the code for tokens (id_token and access_token)
5. ID Token validation
6. Using tokens to access protected endpoints

Next Steps

For Authentication and Security:

1. Get your authentication credentials
2. Configure your redirect URI
3. Implement the authentication flow
4. Integrate Security endpoints

For Connect:

1. Get access token
2. Explore available endpoints
3. Implement specific integrations

For Fanmarket:

1. Configure Melhor Envio integration
2. Use delivery services