Introdução

Bem-vindo à documentação da API Fanbase! Este guia fornece todas as informações necessárias para integrar seu sistema com a plataforma Fanbase, incluindo autenticação, segurança, integrações e serviços.

Sobre a Plataforma Fanbase

A Fanbase oferece uma plataforma completa de gestão de identidades, integrações e serviços através de múltiplas APIs especializadas:

• Autenticação: Sistema de Single Sign-On (SSO) baseado em OpenID Connect e OAuth 2.0
• Security: Endpoints de segurança e gerenciamento de identidades
• Connect: API para integrações, processamento de dados e exportação
• Fanmarket: Integração com serviços de entrega e e-commerce

URLs dos Ambientes

As variáveis abaixo são utilizadas ao longo desta documentação para representar os endereços de cada ambiente e serviço:

Autenticação (Login)

Produção:

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

Homologação:

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

Security (SSO)

Produção:

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

Homologação:

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

Connect (Integrações)

Produção:

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

Homologação:

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

Fanmarket

Produção:

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

Homologação:

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

Serviços Disponíveis

Autenticação

Sistema de autenticação baseado em OpenID Connect que utiliza o Authorization Code Flow, oferecendo:

• Segurança aprimorada: tokens não são expostos ao navegador do usuário
• Validação de assinatura: todos os tokens são assinados e podem ser validados
• Controle de acesso: gestão granular de permissões através de scopes

Ver documentação completa →

Security (SSO)

API de segurança e gerenciamento de identidades que oferece:

• Obtenção de tokens de acesso (client_credentials)
• Recuperação de informações básicas do usuário (UserInfo)
• Acesso ao perfil completo do usuário (Profile)

Ver documentação completa →

Connect

API para integrações e processamento de dados que inclui:

• Queue: Sistema de filas para processamento assíncrono (webhooks, validações, notificações)
• Integrações: Processamento de transações e cadastros em lote
• Exportação: Exportação de dados de surveys e filtros
• Aplicativos: Registro de eventos e dispositivos móveis

Ver documentação completa →

Fanmarket

Integração com serviços de entrega através do Melhor Envio:

• Cálculo e gerenciamento de fretes
• Integração com múltiplas transportadoras
• Gestão de entregas e rastreamento

Ver documentação completa →

Fluxo de Autenticação

O sistema utiliza o Authorization Code Flow do OpenID Connect, que garante segurança ao não expor tokens diretamente no navegador do usuário. O fluxo completo inclui:

1. Solicitação de autenticação no endpoint de login
2. Redirecionamento do usuário para login
3. Recebimento do código de autorização
4. Troca do código por tokens (id_token e access_token)
5. Validação do ID Token
6. Utilização dos tokens para acessar endpoints protegidos

Próximos Passos

Para Autenticação e Security:

1. Obtenha suas credenciais de autenticação
2. Configure sua URI de redirecionamento
3. Implemente o fluxo de autenticação
4. Integre os endpoints de Security

Para Connect:

1. Obtenha token de acesso
2. Explore os endpoints disponíveis
3. Implemente integrações específicas

Para Fanmarket:

1. Configure integração com Melhor Envio
2. Utilize os serviços de entrega