📱 Integrações APPs Private Label
Os APPs Private Label são aplicativos mobile que permitem que parceiros Credsystem ofereçam serviços financeiros — cartão, extrato, empréstimo, arrecadação e muito mais — sob sua própria marca, integrados à plataforma Credsystem.
Este guia apresenta a arquitetura de integração e os pontos de entrada para cada camada.
🏗️ Arquitetura de Integração
A integração é organizada em três camadas interdependentes que devem ser implementadas nesta ordem:
O AllowMe SDK deve ser integrado ao app antes de qualquer chamada de API. O fingerprint do dispositivo coletado pelo SDK é um parâmetro obrigatório em vários endpoints de acesso e onboarding.
🛡️ 1. Segurança do Dispositivo — AllowMe SDK
O AllowMe é o SDK de segurança obrigatório para todos os APPs Private Label. Ele realiza o fingerprinting do dispositivo (Android e iOS via React Native), utilizado como camada antifraude nos fluxos de autenticação.
| O que faz | Quando usar |
|---|---|
| Coleta fingerprint único do dispositivo | Na inicialização do app |
| Identifica dispositivos suspeitos | Em todos os fluxos de acesso |
| Previne fraudes e clonagem de sessão | Parâmetro fingerPrint nas APIs |
👉 Documentação completa do AllowMe SDK
🔐 2. Acesso e Onboarding
Fluxos de autenticação e cadastro de usuários nos APPs Private Label. Todos os fluxos utilizam o fingerprint coletado pelo AllowMe SDK.
| Fluxo | Descrição | Documentação |
|---|---|---|
| 🔑 Login | Autenticação OAuth2 com CPF e senha, geração de tokens de acesso e refresh | Ver Login |
| 👤 Primeiro Acesso | Cadastro inicial: validação de dados, biometria, SMS, perguntas de segurança, termos e criação de senha | Ver Primeiro Acesso |
| 📲 Troca de Dispositivo | Validação de segurança ao acessar de um novo dispositivo não reconhecido | Ver Troca de Dispositivo |
| 🔒 Recuperar Senha | Redefinição de senha via validação de identidade e SMS | Ver Recuperar Senha |
🏠 3. Área Logada
APIs disponíveis após o usuário estar autenticado. Todas as requisições exigem o Bearer Token obtido no fluxo de Login.
| Módulo | Funcionalidades | Documentação |
|---|---|---|
| 💳 Cartão | Listagem, detalhes, gerenciamento de senha, CVV e cartão digital | Ver Cartão |
| 📋 Extrato e Faturas | Faturas passadas, atual e futuras, transações e parcelamento | Ver Extrato |
| 💰 Empréstimo Pessoal | Elegibilidade, simulação, contratação e geração de contratos | Ver Empréstimo |
| 💵 Arrecadação | PIX, boleto, QR Code, comprovantes e PDF de faturas | Ver Arrecadação |
| 🛡️ Venda de Produtos | Consulta, contratação e cancelamento de seguros e proteções | Ver Vendas |
| 👤 Cadastro | Consulta e atualização de dados pessoais e endereços | Ver Cadastro |
| 🤖 Atendimento — Cleo | Assistente virtual, chat, WhatsApp, e-mail e ouvidoria | Ver Atendimento |
| ⚙️ Private Label | Opt-in, anuidades, biometria, carnês e limite emergencial | Ver Private Label |
| 🎁 Promoções | Banners, cashback e programa de fidelidade | Ver Promoções |
📋 Pré-requisitos
| Requisito | Descrição |
|---|---|
| Client ID e Client Secret | Fornecidos pela equipe Credsystem |
| Realm | Nome do realm configurado no Keycloak |
| API Key AllowMe | Necessária para inicializar o SDK de segurança |
| React Native | Configurado para integração do AllowMe SDK |
| OAuth 2.0 | Grant type password para apps mobile de primeira parte |
🆘 Suporte
Contato Técnico
- Email: suporte.tecnico@credsystem.com.br
- Horário: Segunda a Sexta, 8h às 18h (BRT)
Em Caso de Erro
- Anote o traceId retornado no erro
- Capture a requisição completa (sem dados sensíveis)
- Descreva o comportamento esperado vs. obtido
- Envie para o email de suporte com assunto:
[API Integraçao Private Label] - Descrição do Problema
Links úteis: