Overview

Welcome to the Fanbase API documentation! This guide is designed to facilitate effective and secure integration with our complete platform, providing programmatic access to essential features for authentication, identity management, integrations, and services.

About the Fanbase Platform

Fanbase offers a complete identity management and integration 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

Getting Started

To start using our platform, follow these steps:

1. Get Credentials: Contact the Fanbase team to obtain your authentication credentials (client_id and client_secret).
2. Configure Redirect URI: Define together with Fanbase what your redirect URI will be (only for SSO authentication).
3. Implement the Flow: Follow the Getting Started guide to implement the authentication flow.

Authentication

Ensuring transaction security on our platform is essential. For this, we use an authentication system based on OpenID Connect and OAuth 2.0 that requires valid credentials in all requests.

Tokens can be obtained through different flows:

• Authorization Code Flow: For user authentication (SSO)
• Client Credentials: For application authentication (API-to-API)

Include the token in the HTTP header of your calls as follows: Header {"Authorization": "Bearer Your_Token"} or Header {"AccessToken": "Your_Token"}.

This approach ensures that only authorized users and applications can access API resources, maintaining the security of operations and data.

Exploring the Documentation

Find detailed information on the following topics:

• Introduction:

  • Overview
  • Getting Started

• Authentication:

  • Authentication Keys
  • Redirect URI
  • Authentication Request
  • Authentication Response
  • Token Endpoint
  • ID Token
  • ID Token Validation
  • Authentication without Interaction
  • Additional Parameters

• Security (SSO):

  • Get Token
  • UserInfo
  • Profile

• Connect:

  • Queue - Webhook Tickets
  • Queue - KYC Validation
  • Queue - Notify Delivery
  • Queue - Update Fandata
  • IF Transactions
  • ID Batch V2
  • Survey
  • Filter
  • APP Events

• Fanmarket:

  • Melhor Envio Integration

• Reference:

  • Authorization Flow
  • Error Messages

• Examples:

  • Implementations in different languages

We look forward to seeing how you will use our platform in your operations!