Skip to main content
As collections incluem todos os 12 endpoints públicos da API GYRA+, organizados por pasta, com variáveis de ambiente, exemplos de request body e scripts de automação (Postman).

​
Baixar Collection

Postman

Collection v2.1 com scripts que salvam o token e IDs automaticamente.Baixar Collection Postman

Insomnia

Collection v4 com ambiente pré-configurado (variáveis de produção).Baixar Collection Insomnia

​
O que vem na collection?

Cada collection inclui os mesmos 12 endpoints, organizados em 5 pastas:
PastaEndpointsDescrição
AuthPOST /auth/authenticateGera o token JWT
ReportPOST /report, GET /report/{id}, GET /report/{id}/section/{type}, GET /report/list, POST /report/{id}/financial-tab, POST /report/analyzeCriar e consultar relatórios
Credit PolicyGET /credit-policy/policyListar políticas de crédito
WebhookPOST /webhook, GET /webhook/findBy, DELETE /webhook/{id}Gerenciar webhooks
HealthGET /healthVerificar se a API está online

​
Como importar no Postman

1

Baixe o arquivo JSON

Clique no botao acima para baixar gyra-postman-collection.json.
2

Abra o Postman e importe

No Postman, clique em Import (canto superior esquerdo) e arraste o arquivo JSON ou clique em Upload Files.
3

Configure suas credenciais

Abra a collection GYRA+ API e clique na aba Variables. Substitua os valores:
VariávelO que colocar
clientIdSeu Client ID (painel GYRA+ ou bizdev@gyramais.com)
clientSecretSeu Client Secret
policyIdID de uma politica de credito ativa
Salve com Ctrl+S.
4

Autentique e comece a testar

Execute o request Auth / Autenticar. O script de teste salva automaticamente o accessToken nas variáveis da collection — todos os outros requests já usam esse token.Depois, execute Report / Criar Relatório e o reportId também é salvo automaticamente para os próximos requests.
Dica Postman: A collection usa scripts pm.collectionVariables.set() para salvar automaticamente o accessToken, reportId e webhookId após cada request de criação. Você não precisa copiar e colar IDs manualmente.

​
Como importar no Insomnia

1

Baixe o arquivo JSON

Clique no botão acima para baixar gyra-insomnia-collection.json.
2

Abra o Insomnia e importe

No Insomnia, vá em Application (menu superior) e depois Import. Selecione o arquivo JSON.
3

Configure o ambiente

O ambiente GYRA+ Produção já vem criado com as variáveis. Clique no seletor de ambiente (canto superior esquerdo) e edite:
VariávelO que colocar
clientIdSeu Client ID
clientSecretSeu Client Secret
policyIdID de uma política ativa
4

Autentique e comece a testar

Execute Auth / Autenticar. Copie o accessToken da resposta e cole na variável de ambiente accessToken.Depois, use os requests da pasta Report para criar e consultar relatórios.
Diferença importante: No Insomnia, você precisa copiar o token manualmente para a variável de ambiente. No Postman, isso é feito automaticamente pelos scripts de teste.

​
Variáveis de ambiente

Ambas as collections usam as mesmas variáveis:
VariávelValor padrãoDescrição
baseUrlhttps://gyra-core.gyramais.com.brURL base da API
clientIdSEU_CLIENT_ID_AQUICredencial de autenticação
clientSecretSEU_CLIENT_SECRET_AQUICredencial de autenticação
accessToken(vazio)Preenchido automaticamente (Postman) ou manualmente (Insomnia)
reportId(vazio)ID do ultimo relatório criado
policyIdSEU_POLICY_ID_AQUIID da política de crédito
webhookId(vazio)ID do ultimo webhook registrado

​
Fluxo recomendado para testes

1. POST /auth/authenticate        → Obtem token
2. GET  /credit-policy/policy      → Lista políticas (pegue um policyId)
3. POST /report                    → Cria relatório (salve o reportId)
4. GET  /report/{id}               → Consulta o relatório completo
5. GET  /report/{id}/section/CREDIT_POLICY → Ve a decisão da política
6. POST /webhook                   → Registra webhook para produção
Precisa de credenciais? Solicite para bizdev@gyramais.com ou acesse o painel do Toolbox.