Pré-requisitos para implementação utilizando API's
Para garantir uma integração eficaz e segura com as APIs do FitBank/EasyCrédito, os seguintes pré-requisitos devem ser atendidos pelos agentes que irão realizar a integração:
Pré-requisitos:
- URL para Callback: Os Canais precisam fornecer uma URL específica para o recebimento de callbacks. Esta URL será utilizada para que o Marketplace de Crédito possa enviar notificações de eventos e atualizações em tempo real. Certifique-se de que a URL esteja devidamente configurada e acessível a partir dos servidores do FitBank/EasyCrédito.
Para garantir a segurança das informações, recomenda-se o uso de autenticação, que pode ser feita de diferentes formas, como Bearer Token ou Basic Auth. Abaixo estão os quatro modelos de callback com métodos de autenticação exemplificados:Modelos de URL e Autenticação:
Modelo 1: Autenticação Bearer Token
Neste modelo, a autenticação é feita por meio de um token Bearer, onde o servidor adiciona o token de acesso no cabeçalho Authorization. Esse método é mais seguro, pois não exige o envio direto de credenciais como usuário e senha.
URL: https://meusite.com/integracao/easyc/webhook
headers: {
"Authorization": "Bearer xxxxxxxxxxxxxxxxxxxxx"
}Modelo 2: Autenticação Basic Auth
Neste modelo, a autenticação é feita utilizando o método Basic Auth, que exige um nome de usuário e senha codificados em Base64. Esse método é simples, mas deve ser usado junto com HTTPS para garantir a segurança das credenciais transmitidas.URL: https://meusite.com/integracao/easyc/webhook
headers: {
"Authorization": "Basic <username:senha codificados em Base64>"
}Modelo 3: URL com Token no Header (x-auth-token)
Neste modelo, o token de autenticação é enviado no cabeçalho x-auth-token. Este método é direto e pode ser eficaz para ambientes onde o token é gerado e gerenciado de forma segura.
URL: https://meusite.com/integracao/easyc/webhook
headers: {
"x-auth-token": "xxxxxxxxxxxxxxxxxxxxx"
}Modelo 4: URL com Token na Query String
Neste modelo, o token é passado como parâmetro na query string da URL. Esse método é menos seguro, pois o token fica exposto na URL, mas pode ser útil em situações de autenticação simples. Recomenda-se o uso de HTTPS para proteger as informações em trânsito.
URL: https://meusite.com/integracao/easyc/webhook?token=xxxxxxxxxxxxxxxxxxxxx
Observação:
Lembre-se de que o uso de HTTPS é essencial para proteger os dados em trânsito, especialmente ao utilizar métodos como Basic Auth ou o envio de token pela query string. Além disso, é importante que o token ou as credenciais estejam sempre atualizados para manter a segurança do canal e evitar acessos não autorizados.
- Credenciais de Acesso: Para garantir a segurança e integridade dos dados transmitidos, é necessário que os agentes possuam um token de autenticação válido. Para ter acesso ao token, é necessário ter as credenciais de autenticação, fornecidas via e-mail pelo FitBank/EasyCrédito durante a fase de integração. Com as credenciais disponíveis, será possível solicitar o token que permitirá o acesso e que deve ser incluído em todas as requisições realizadas.
- IP Fixo para requisições: Por questões de segurança, é obrigatório que os agentes utilizem endereços de IP fixos tanto para o acesso às APIs quanto para o envio de dados. Isso permitirá que o FitBank/EasyCrédito aplique políticas de segurança mais restritivas, garantindo que as requisições sejam originadas apenas de fontes confiáveis.
- E-mail para Cadastro: Um e-mail corporativo deve ser fornecido para a criação de contas e o recebimento das credenciais necessárias para a integração. Este e-mail será o canal de comunicação oficial para o envio de informações confidenciais, como chaves de API, instruções detalhadas e suporte técnico relacionado à implementação.
Updated about 1 month ago