antecipa fácilDEVELOPERS
API v1
Primeiros passos
Markdown ↗

Comece pela sua primeira chamada

Conecte sua conta à API do Antecipa Fácil. Um caminho claro, da chave à primeira resposta.

Uma integração para todo o Portal

A API reúne consultas de contas, cadastro, negociações, recebíveis e títulos. Cedentes e financiadores usam a mesma referência. A conta e as permissões da chave determinam quais dados cada integração pode consultar.

1. Crie uma chave de acesso

Entre com Google ou Microsoft usando o mesmo e-mail do Portal. Abra Chaves de acesso. Escolha uma conta vinculada, informe um nome para a integração, selecione as permissões e defina a validade. A chave completa aparece uma única vez. Guarde-a no gerenciador de segredos da sua aplicação.

2. Consulte a identidade da integração

Envie a chave no cabeçalho X-API-Key. A resposta identifica a conta autorizada e seus escopos. AF_API_KEY é uma variável de ambiente da sua aplicação; substitua o exemplo somente no seu ambiente seguro.

Exemplo
curl 'https://api-end.antecipafacil.net.br/v1/onboarding/me' \
  --header 'Accept: application/json' \
  --header "X-API-Key: $AF_API_KEY"

3. Explore os endpoints

Abra a Referência da API. Escolha o serviço e a operação. Preencha os parâmetros obrigatórios no painel de teste. Confira a resposta HTTP. Use apenas identificadores retornados pela sua conta. Um identificador de outra empresa não concede acesso.

4. Prepare a integração

Mantenha chaves de teste e de produção separadas. Trate falhas e limites HTTP. Revogue uma chave que não será mais usada. O contrato público atual permite consultas; ele não autoriza criar lances, aprovar operações ou movimentar recursos financeiros.

Digite para buscar guias e operações da API.