Configuração
Para implementar os serviços do FGTS, é necessário que o parceiro configure uma URL para o recebimento dos eventos de callback.
Nesta etapa, o parceiro precisa configurar:
- Uma URL para recebimento dos callbacks;
- Essa URL precisa ter um ambiente de homologação e um de produção;
- A URL precisa ser desenvolvida para receber requisições do tipo
GET
ouPOST
; - Um método de autenticação aceito pela BMP.
Após configurar a URL de callback (homologação e produção), escolher qual método HTTP e qual o método de autenticação devem ser utilizados, o parceiro deve informar ao time de implantação da BMP, para que essa configuração seja parametrizada na credencial do parceiro.
Acompanhe, abaixo, os detalhes técnicos de cada uma dessas configurações.
1. URL
O parceiro precisa desenvolver uma URL de callback e enviá-la para a BMP.
Essa URL será utilizada para a comunicação da BMP com o parceiro, atavés de eventos de callback.
2. Ambientes
O callback para acompanhamento dos status das propostas deve ser enviado tanto para o ambiente de homologação quanto para o ambiente de produção.
Recomenda-se que sejam utilizadas URLs diferentes para cada ambiente.
2.1 Exemplos de URL de homologação
2.2 Exemplos de URL de produção
3. Métodos de chamada
O parceiro deve escolher um método HTTP que gostaria de utilizar para recebimento dos callbacks.
Opções disponíveis incluem:
POST
GET
4. Autenticação
É recomendado, também, que o parceiro defina um método de autenticação para recebimentos dos callbacks.
Opções disponíveis incluem:
Método de autenticação | Tipo da chave | Exemplo de token |
---|---|---|
Bearer Token | Authorization | Bearer eyJhbGciOiJIUzI1CI6IkpXVCJ9 |
API Key | API-Key | 1234567890abcdef1234567890abcdef |
Basic Authentication | Authorization | Basic dXNlcm5hbWU6cGFzc3dvcmQ |
X-API-Key | X-API-Key | 0987654321fedcba0987654321fedcba |
JWT (JSON Web Token) | Authorization | Bearer eyJhbGciOiJIUzI1NiIs |
HMAC (Hash-based Message Authentication Code) | Authorization | HMAC 5d41402abc4b19d911017c592 |