Migração de Beneficios

O objetivo desta documentação é orientar os parceiros de integração sobre o procedimento para atualização do sistema de autenticação e das rotas das APIs da Creditas Benefits. Essas mudanças fazem parte de um esforço contínuo para aprimorar a organização da nossa infraestrutura e a escalabilidade das integrações, visando uma performance mais eficiente e segura.

Priorizamos a implementação de práticas avançadas de segurança para assegurar a proteção dos dados dos nossos parceiros e clientes. Essa iniciativa está alinhada ao nosso compromisso de adotar as melhores técnicas de segurança, buscando excelência e confiabilidade em nossos serviços.

Alterações

Rotas

Temos 4 grande grupos de rotas que foram alteradas. Abaixo segue alguns exemplo do que foram alterado. Porém basicamente a alteração envolve apenas o dominio e path inicial.

Alterações para API de AtWork:

- https://buzz-sandbox.creditoo.com.br/api/partner/v1/client
+ https://stg-api.creditas.io/b2b/benefits/api/partner/v1/client

Alterações para API de Conciliação:

- https://stg-api.creditas.io/benefits/conciliations/statements
+ https://stg-api.creditas.io/b2b/benefits/conciliations/statements

Alterações para API de Rescisão:

- https://stg-api.creditas.io/benefits/terminations/companies/{companyDocument}/employee-termination
+ https://stg-api.creditas.io/b2b/benefits/terminations/companies/{companyDocument}/employee-termination

Alterações para API Transferencia de colaborador:

- https://stg-api.creditas.io/benefits/employee/transfer/employee
+ https://stg-api.creditas.io/b2b/benefits/employees/transfer/employee

Autenticação

O modelo de autenticação também passou por mudanças significativas, com a implementação de mecanismos mais eficientes para controlar o acesso às informações, garantindo assim uma segurança reforçada no acesso aos dados.

No modelo anterior, a autenticação era realizada através do envio de três cabeçalhos específicos: signature-stamp, signature e signature-key.

Com a nova estrutura de autenticação, agora é necessário solicitar um token de acesso temporário utilizando suas credenciais de acesso. Este método visa simplificar e fortalecer o processo de autenticação, assegurando uma camada adicional de proteção para as informações acessadas.

curl --location --request POST 'https://auth-staging.creditas.com.br/api/affiliate_clients/tokens' \
--header 'Accept-Version: v1' \
--header 'Content-Type: application/json' \
--data-raw '{
    "consumer_key": "{{consumer_key}}",
    "consumer_secret": "{{consumer_secret}}"
}'
{
    "access_token": "1234SFDSF42423dfvxc",
    "token_type": "bearer",
    "refresh_token": "refresh-token",
    "expires_in": 7200
}

Exemplo de utilizaçào com a diferença

  curl --location --request POST '{{endpoint}}' \
  --header 'Content-Type: application/json;charset=UTF-8' \
-  --header 'signature-stamp: xxx' \
-  --header 'signature: xxx' \
-  --header 'signature-key: xxx' \
+  --header 'Authorization: Bearer {{access_token}}' \

Consulte mais informações sobre a autenticação!.