Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
O que você vai fazer

Neste guia você vai:
  1. Obter suas credenciais
  2. Autenticar na API
  3. Criar seu primeiro relatório de crédito
  4. Ler a decisão automática
Tempo estimado: 5 minutos.

​
Pré-requisitos

  • gyra-client-id e gyra-client-secret recebidos no onboarding
  • Um CPF ou CNPJ para testar
Ainda não tem credenciais? Entre em contato com atendimento@gyramais.com e solicite o acesso.

​
Passo 1, Autenticar

Gere seu token JWT enviando suas credenciais no header da requisição: 
curl -X POST https://gyra-core.gyramais.com.br/auth/authenticate \
  -H "gyra-client-id: SEU_CLIENT_ID" \
  -H "gyra-client-secret: SEU_CLIENT_SECRET"
Resposta: 
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiresIn": 86400
}
Guarde o accessToken, você vai usá-lo em todas as próximas requisições.

​
Passo 2, Criar o relatório

Chame o endpoint POST /report com o documento e o policyId do template desejado: 
curl -X POST https://gyra-core.gyramais.com.br/report \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "43591367000130",
    "type": "CNPJ",
    "policyId": "679955e0485aa2f033203f98",
    "externalId": "meu-pedido-001"
  }'
Resposta imediata: 
{
  "id": "64a3b2c1d4e5f6a7b8c9d0e1",
  "status": "PENDING",
  "document": "43591367000130",
  "createdAt": "2025-03-01T10:30:00.000Z"
}
O status PENDING é esperado, o processamento é assíncrono.

​
Passo 3, Consultar o resultado

Use o id retornado para consultar o relatório após alguns segundos: 
curl https://gyra-core.gyramais.com.br/report/64a3b2c1d4e5f6a7b8c9d0e1 \
  -H "Authorization: Bearer {accessToken}"
Resposta com decisão: 
{
  "id": "64a3b2c1d4e5f6a7b8c9d0e1",
  "status": "APPROVED",
  "policyStatus": "APPROVED",
  "score": 720,
  "document": "43591367000130",
  "sections": [...]
}

​
Passo 4, Interpretar a decisão

CampoO que significa
statusStatus geral do relatório
policyStatusDecisão da política de crédito: APPROVED, DENIED ou ALERT
scoreScore composto calculado pela política (0–1000)
sectionsDados detalhados por seção temática
Para produção, evite polling e configure um webhook para receber a decisão automaticamente assim que o relatório for concluído.

​
Próximos passos

Configurar webhook

Receba a decisão em tempo real no seu sistema sem polling.

Entender a decisão

Saiba como ler o resultado da política e as regras avaliadas.

Criar política personalizada

Adapte os critérios de análise para o seu modelo de risco.

Integrar com n8n

Use os templates prontos para conectar com seu ERP ou CRM em minutos.