API V8 Digital

Objetivo desta documentação

Esta documentação orienta equipes técnicas que precisam iniciar a integração com as APIs da V8 Digital.

O objetivo desta página é apresentar a estrutura geral da documentação, os pré-requisitos de acesso e o caminho recomendado para implementar os produtos disponíveis de forma segura.

Atualmente, a documentação contempla os fluxos de:

• Saque Aniversário FGTS

• Crédito Privado CLT

Ao longo das páginas técnicas, você encontrará orientações sobre autenticação, simulações, criação de propostas, consultas, cancelamentos, resolução de pendências, webhooks e demais operações disponíveis para cada produto.

Antes de começar

Para consumir os recursos das APIs, sua equipe precisa obter as chaves de autenticação.

Essas credenciais devem ser solicitadas diretamente com a gerente comercial responsável. Depois de recebidas, todas as requisições devem incluir os headers de autenticação definidos nas páginas técnicas da documentação.

Atenção: as credenciais de homologação são diferentes das credenciais de produção.

Como usar esta documentação

Use esta documentação como guia de implementação das APIs. Antes de iniciar o desenvolvimento, revise as páginas técnicas do produto que será integrado para entender:

• quais endpoints estão disponíveis;

• quais métodos HTTP são suportados;

• quais parâmetros devem ser enviados;

• quais formatos de resposta são retornados;

• quais status codes podem ocorrer;

• quais exemplos de payload devem ser seguidos.

Essa leitura ajuda a garantir que a integração respeite o contrato da API desde o primeiro teste.

Produtos e recursos disponíveis

A documentação está organizada por produto para facilitar a consulta durante a integração.

Saque Aniversário FGTS

Inclui páginas para autenticação, consulta de saldo, consulta de tabelas, simulação, criação de proposta, consulta de bancos, acompanhamento de operações, cancelamento, resolução de pendências e webhooks.

Crédito Privado CLT

Inclui páginas para autenticação, termo de consentimento, simulação, criação de proposta, listagem de operações, cancelamento, resolução de pendências e webhooks.

Os recursos seguem padrões RESTful e utilizam JSON como formato de troca de dados.

Fluxo recomendado de integração

• 1. Solicite as credenciais de acesso com a gerente comercial responsável.

• 2. Configure a autenticação conforme os headers definidos na documentação.

• 3. Execute os primeiros testes no ambiente de homologação.

• 4. Valide os fluxos principais antes de usar dados reais.

• 5. Consulte as páginas específicas de cada recurso durante a implementação.

• 6. Acione o suporte técnico com payloads, responses e contexto quando precisar de apoio.

Ambiente de homologação

Todas as integrações devem ser validadas primeiro em ambiente de homologação.

Esse ambiente simula o comportamento da produção com dados controlados, permitindo testar o fluxo completo sem impactar dados reais.

Suporte técnico

Para dúvidas técnicas, reporte de erros ou acompanhamento da integração, entre em contato pelo e-mail ti@v8digital.online.

Ao solicitar suporte, envie as informações técnicas completas:

• payloads enviados;

• responses recebidos;

• contexto da requisição.

Esses dados ajudam a equipe da V8 Digital a analisar o caso com mais precisão e acelerar a resolução.

Próximo passo

Depois desta introdução, escolha o produto que será integrado, siga para a respectiva página de autenticação e avance para os recursos específicos do fluxo que sua integração precisa implementar.