Simulador de Fluxo: Avanço de Etapas
Este endpoint é exclusivo para o ambiente de Staging (Homologação). Ele permite que você force o avanço de uma proposta para qualquer etapa do fluxo, permitindo testar sua integração com estados específicos (como aprovação, documentos ou pagamento) de forma instantânea.
1. Por que usar?
A utilização desse endpoint antes do deploy é importante pois:
- Agilidade: Não espere por análises manuais para ver como seu sistema reage a uma proposta aprovada.
- Testes de Erro: Simule rejeições de propostas para validar suas mensagens de erro ao cliente.
- Validação de Webhooks: Verifique se seu sistema recebe corretamente as atualizações de status em cada fase
2. Funcionalidade
Utilize este endpoint para manipular manualmente o progresso da sua proposta. Você pode simular os seguintes cenários:
- Avançar: Move a proposta instantaneamente para a próxima etapa da esteira.
- Rejeitar: Simula uma reprovação de crédito para testar seus fluxos de erro.
- Atualizar Análise: Gera novas ofertas de crédito enquanto a proposta estiver em análise.
Todos os steps irão avançar conforme a esteira, com exceção de inspeção que irá inicializar junto com documento.
Importante
Ao utilizar este simulador para avançar manualmente, o link de vistoria real não será gerado. Use este recurso apenas para testar a lógica de status e transições da sua plataforma.
3. Referência Técnica
3.1. Request HTTP
| Tipo da Requisição | URL | Exemplo |
|---|---|---|
PUT | {{url_base}}/proposals/homologation/next-step/:id | https://stg-api.creditas.io/b2b/proposals/homologation/next-step/B2B-68238B7C-EF31-4E5F-9BF4-B12931062863 |
3.2. Path Params
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | Id gerado na criação da proposta |
3.3. Request Body**
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reject | Boolean | Não | Se estiver true, a proposta irá negar o step atual e não irá avançar na esteira |
updateCredit | Boolean | Não | Se estiver true, contanto que a proposta não esteja negada ou step LOAN_PROPOSAL_ANALYSIS já tenha sido encerrado, ela irá adicionar uma nova opção de crédito |
3.4. Request Headers
| Header | Valor |
|---|---|
Accept | application/vnd.creditas.v1+json |
Content-Type | application/json;charset=UTF-8 |
Authorization | Bearer {{AUTHENTICATION_TOKEN}} |
3.5. Exemplo de Request e Response
curl --location --request PUT 'https://stg-api.creditas.io/b2b/proposals/homologation/next-step/B2B-68238B7C-EF31-4E5F-9BF4-B12931062863' \
--header 'Authorization: Bearer {your_access_token}' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json' \
--data '{
"reject": false,
"updateCredit": false
}'{
"id": "B2B-25F4B539-314E-4D31-8753-35E5638CDDC6",
"status": "ONGOING",
"steps": [
{
"progress": {
"startedAt": "2023-04-28T13:29:06.443278",
"finishedAt": "2023-04-28T13:29:06.443281"
},
"name": "PROPOSAL_CREATED"
},
{
"progress": {
"startedAt": "2023-04-28T13:29:06.443291",
"finishedAt": "2023-04-28T13:29:17.644081"
},
"name": "PRE_QUALIFICATION"
},
{
"progress": {
"startedAt": "2023-04-28T13:29:17.810645",
"finishedAt": "2023-04-28T13:29:20.414622"
},
"name": "PROCESSING"
},
{
"progress": {},
"name": "LOAN_PROPOSAL_ANALYSIS"
},
{
"progress": {},
"name": "DOCUMENTS"
},
{
"progress": {},
"name": "COLLATERAL_INSPECTION"
},
{
"progress": {},
"name": "CONTRACT"
},
{
"progress": {},
"name": "LOAN_PAYMENT"
}
],
"feeds": [
{
"id": "aa06e6ae-e603-41e2-939e-8219374e2de1",
"createdAt": "2023-04-28T13:29:17.863598",
"name": "PROPOSAL_QUALIFIED"
}
]
}Updated 13 days ago