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 ou POST;
  • 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.

Veja os exemplos de URL no próximo passo, abaixo.

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

www.exemplo-de-url-de-homologacao.com.br

2.2 Exemplos de URL de produção

www.exemplo-de-url-de-producao.com.br

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çãoTipo da chaveExemplo de token
Bearer TokenAuthorizationBearer eyJhbGciOiJIUzI1CI6IkpXVCJ9
API KeyAPI-Key1234567890abcdef1234567890abcdef
Basic AuthenticationAuthorizationBasic dXNlcm5hbWU6cGFzc3dvcmQ
X-API-KeyX-API-Key0987654321fedcba0987654321fedcba
JWT (JSON Web Token)AuthorizationBearer eyJhbGciOiJIUzI1NiIs
HMAC (Hash-based Message Authentication Code)AuthorizationHMAC 5d41402abc4b19d911017c592
Em todos os métodos de autenticação aceitamos chaves com até 288 caracteres.