Guia de migração: Affiliates para B2B API

📘

Estamos no processo de lançamentos de funcionalidades para evoluir sua experiência como parceiro API. Confira nossa página de visão geral para obter os detalhes e continue checando nosso changelog para atualizações sobre os lançamentos!


📝 Quais mudanças foram feitas no código de integração?


1 - Update de url dos endpoints

Fizemos mudança nos nomes dos request URLs, agora as urls se iniciam com /b2b e não levam mais o nome do produto.

URL DE

URL PARA

/affiliates/auto/refinancing/simulations

/b2b/simulations

/affiliates/auto/refinancing/leads/eligibility

/b2b/borrowers/eligibility

/affiliates/auto/refinancing/leads

/b2b/proposals

/affiliates/auto/refinancing/leads/:id/status

/b2b/proposals/:proposalId/status

/vehicles/brands

/b2b/vehicles/brands?year=2021

/vehicles/models

/b2b/vehicles/models?brand=BMW&year=2021


2 - Campos agora estão organizados dentro de objetos correspondente das infos


3 - Padrão de campo de under_score para camelCase

Abaixo deixamos 2 exemplos mas a partir de agora todos os campos seguem o novo padrão:

CAMPO DE

CAMPO PARA

cellphone_code

cellphoneCode

authorization_terms

authorizationTerms


4 - Update no header, agora padronizado

O endpoint da proposta que espera campos sobre navegador e localização são agora esperados no header e não mais no body na request

Request body ANTERIOR

{   
        "whatsapp_optin: {
            phone_code: "41",
            phone: "995862183",
            ip: ""45.5.222.52",
            user_agent: "Mozilla/5.0 (Linux; Android 11; SM-A305GT Build/RP1A.200720.012; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/94.0.4606.61 Mobile Safari/537.36 isphoenix"
        }
}

Request body NOVO

A informação passa a ser enviada dentro do objeto Borrower, confira mais informações aqui

{   
        "optIns: {
            whatsApp: true
        }
}

5 - Update do formato de response

Os responses agora retornam direto o objeto, sem o path do endpoint, veja o DE/PARA abaixo:

Request body ANTERIOR

{
    "auto/refinancing/simulation": {
        "loan_term": 12,
        "monthly_interest_rate": 0.0283,
        "total_effective_cost": 0.041449965531432875,
        "installment_amount": 3363.12,
        "loan_amount": 30000.0
    }
}

Request body NOVO

{
        "loan_term": 18,
        "monthlyIncome": 0.0237,
        "total_effective_cost": 0.041449965531432875,
        "installment_amount": 3363.12,
        "loan_amount": 30000.0
    }

6 - Remoção do campo molicarCode

No endpoint de criação da proposta não é mais necessário o envio desse campo, agora solicitamos o envio das informações referentes ao veículo e realizamos a busca internamente



🚧

Recomendação importante

É altamente recomendado que realize todas as suas mudanças em um ambiente de homologação utilizando as suas credenciais de staging, não queremos que sua operação pare então aproveite nosso ambiente de staging para realizar suas mudanças com segurança.

Processo de homologação

A homologação permite que a Creditas verifique que os requests realizados para a API estejam dentro dos padrões necessários para que sua aplicação funcione corretamente, garantindo também o uso de todos os novos benefícios disponíveis.

Temos um processo de monitoramento para garantir o healthcheck da aplicação e com nossa homologação conseguimos direcionar uma integração mais saudável.

Para isso, após realizar a implementação, pedimos que realize o fluxo utilizando suas credenciais do ambiente de staging e em seguida abra um chamado solicitando a realização do procedimento.

Confirma mais informações sobre como realizar o processo de homologação da sua migração.




👩‍🏫 FAQ

Por onde devo começar?

Solicite primeiramente suas novas credenciais de staging através do seu consultor Creditas, a partir desse momento você será direcionado para o processo de integração e homologação conforme nosso guia .


O que muda na experiência front para o meu cliente?

Agora com os novos endpoints de veículos e profissões você poderá exibir uma experiência onde o cliente poderá selecionar conforme as informações que retornamos. Você pode usar como referência a experiência do nosso site Creditas, nela exibimos uma lista de marcas e depois uma lista de modelos conforme o cliente vai selecionando.

Para os campos de profissões sugerimos a mesma experiência por fases, exibindo primeiro uma lista para que o cliente possa selecionar qual o sua situação profissional e conforme sua resposta, deixá-lo selecionar sua profissão conforme nossa lista de profissões, isso para os casos de situação Autônomo ou Profissional Liberal.


**Qual o tempo de homologação?

Nosso time está atuando o mais rápido possível e com isso nosso SLA está em até 4 dias, chegando a ser mais rápido em casos onde o parceiro nos envia as informações conforme o processo de homologação.