API Gateway
Acesso autenticado · Bearer token

API Externa

Documentação das rotas expostas externamente através do gateway. Todas as chamadas passam por um único ponto de entrada e são roteadas para os serviços internos da plataforma.

Ambiente
Base URL
Gateway {{ gatewayName }} · ID {{ gatewayId }}

Visão geral

O gateway concentra, em um único domínio, as rotas públicas dos serviços da VERT Capital. Cada requisição é autenticada, validada e encaminhada (proxy) para o serviço de origem correspondente. Use sempre a Base URL do ambiente desejado como prefixo dos caminhos abaixo.

{{ totalEndpoints }}
endpoints expostos
{{ totalServices }}
grupos de serviço
3
ambientes (stg · hml · prd)

Autenticação

A maior parte dos endpoints exige um access token no cabeçalho Authorization. Obtenha o par de tokens em POST /auth/token usando suas credenciais de cliente (email, client_id e client_secret) e renove-o em POST /auth/refresh com o refresh_token quando expirar. O campo expires_at da resposta é um timestamp Unix (segundos) indicando quando o access token deixa de valer.

1 · Obter token
{{ curlToken }}
2 · Renovar token
{{ curlRefresh }}
3 · Chamar com o token
{{ curlUse }}
Resposta de /auth/token e /auth/refresh
{{ respToken }}

{{ g.title }}

{{ g.desc }}

{{ g.count }}
{{ sec.title }}
{{ ep.m }}
{{ seg.val }} {{ seg.val }}
{{ ep.s }}
URL completa
{{ ep.fullUrl }}
Parâmetros de caminho
{{ p.name }} {{ p.label }}
Exemplo · cURL
{{ ep.curl }}
Testar endpoint
{{ ep.sendHint }}
{{ ep.testStatus }} {{ ep.testTime }}
{{ ep.testError }}
Falha ao alcançar o gateway pelo proxy da doc. Verifique a conexão e o ambiente selecionado. Localmente (fora do container nginx) o proxy /__api/ não existe — use o cURL acima a partir do seu backend ou terminal.
{{ ep.testBody }}
access_token recebido. Use-o nas demais chamadas.
Destino interno {{ ep.upstream }}

Nenhum endpoint corresponde aos filtros aplicados.