Doc: Migração de Etapas (V1 ➡️ V2)#
Na versão 2 (V2) da API, as configurações da Organização deixaram de ser chamadas de forma granular. O payload foi unificado para espelhar a nova UI, agrupando os submódulos em 5 Macro-Etapas.A etapa celcoin foi descontinuada como um endpoint isolado e as suas configurações agora devem ser enviadas dentro de endorser.additional_settings.CELCOIN.
Tabela de Mapeamento (De -> Para)#
| Etapa Anterior (V1) | ➡️ | Nova Macro-Etapa (V2) | Verbo HTTP | Ação no Backend |
|---|
start, clients, requests | ➡️ | identification | POST / PUT | Atualiza dados básicos, visão do cliente e notificações de requisição. |
operations, commission, credit_analysis | ➡️ | operation | PUT | Atualiza taxas, comissões, multas, regras da operação e análise de crédito. |
endorser, webhooks, qprof (+ celcoin) | ➡️ | integrations | PUT | Atualiza integrações externas, QProf, Webhooks e Endossantes (incluindo as configs adicionais). |
signatures, emails, onboarding, simplified_contract | ➡️ | communication | PUT | Atualiza APIs de assinatura, disparos de e-mail, onboarding background e contrato simplificado. |
whitelabel_custom | ➡️ | whitelabel | PUT | Atualiza domínios, temas, logos e aparência geral do app/web. |
| (Nenhuma - Apenas Leitura) | ➡️ | revision | GET | Utilizar a rota GET /organizations/{uuid} para buscar o resumo completo da organização. |
💡 Comportamento de Resposta (V2)#
Diferente da V1 que retornava 204 No Content, agora os endpoints de POST (create) e PUT (update) retornam um status 200/201 contendo o progresso atualizado da configuração para facilitar a gestão de estado no Front-end:{
"message": "Etapa salva com sucesso.",
"progress": {
"percentage": 80,
"pendencies": [
"Definir logo (tema escuro) enviado"
],
"checklist": {
"identification": true,
"operation": true,
"integrations": true,
"communication": true,
"whitelabel": false
}
}
}
Modificado em 2026-05-18 14:13:35