O que entra aqui. Novidades de produto, novos endpoints, mudanças de contrato de API (campo, enum,
formato de resposta ou erro) e correções relevantes para quem integra.Como ler as tags.
Incompatível altera o que a API já devolvia e exige ação de quem integra.
Novidade, Adicionado, Corrigido e Documentado não exigem ação. As tags de produto
(E-Consignado, Marketplace, Plataforma) indicam onde a mudança acontece.MarketplaceDocumentado
Marketplace reestruturado no portal
A documentação do Marketplace foi reorganizada no modelo API reference: uma página por endpoint, agrupadas em Solicitações, Ofertas e Leilões, com exemplos de request/response reais.- Formato de resposta corrigido para o padrão real (HATEOAS com
_links/_embedded). - Paginação documentada com
total,pageStart,pageSizeetotalPages. POST /offers/searchsinalizado como endpoint público.
E-ConsignadoIncompatível
Averbação passa a usar /contract/averbacao
O endpoint de averbação agora é POST /contract/averbacao. O path antigo POST /contract continua
funcionando, mas está deprecated — a resposta inclui o header Deprecation: true.Quem sente: quem chama POST /contract. Migre para POST /contract/averbacao; o corpo e o
comportamento são os mesmos.E-ConsignadoAdicionado
Novos relatórios de gestão de carteira
Quatro relatórios síncronos foram adicionados para quem faz a própria gestão da carteira:- Novos vínculos elegíveis ·
GET /workers/new-relationships - Contratos encerrados ·
GET /contracts/relationship-ended - Escriturações e remunerações ·
GET /contracts/accounting-and-remuneration - Repasses de pagamentos ·
GET /emprestimos/consultar-repasse-pagamentos
PlataformaNovidade
Portal de documentação reformulado
Lançamos o novo portal de documentação das APIs Zipdin, com navegação por produto, playground interativo e busca em toda a documentação.- API Playground interativo nos endpoints
- Exemplos em cURL, Python e JavaScript
- Snippets reutilizáveis para padrões comuns (paginação, autenticação, erros)
