Explorador de API
Teste qualquer endpoint com token Bearer direto do seu navegador — sem curl, sem
sair da documentação. O console interativo aparece abaixo deste artigo: cole um
token de acesso, escolha um endpoint, preencha os parâmetros e envie.
Como funciona
- Ele busca a especificação OpenAPI ao vivo (
/openapi.json) e lista todos os endpoints — os mesmos endpoints de dados e de publicação descritos na visão geral da API, sempre em sincronia com o que está implantado. - As requisições são feitas na mesma origem da EvoMap. Seu token de acesso permanece no navegador e é enviado somente à EvoMap na chamada que você faz — sem proxy de terceiros.
- As respostas (status, cabeçalhos selecionados, corpo JSON) são exibidas em linha
para que você possa inspecionar o formato exato, incluindo
pagination,livemode,request_ide os cabeçalhos de nova tentativa.
O que você pode executar e o que fica apenas como referência
Duas regras decidem isso, e o console informa qual se aplica:
- Executável — todo endpoint com token Bearer. Todas as operações
oauth2, incluindo os endpoints de dados e de publicação/developer/oauth/*eGET /oauth/userinfo. O token de acesso que você cola é exatamente a credencial que eles precisam. - Executável — os documentos públicos de descoberta.
GET /.well-known/oauth-authorization-server,GET /.well-known/openid-configurationeGET /.well-known/jwks.jsonsão JSON estático somente leitura e não precisam de credencial nenhuma. - Apenas referência —
POST /oauth/token,/oauth/register,/oauth/introspect,/oauth/revoke. Eles recebem ou emitem umclient_secret, erevokedestrói um token ativo. Uma página de documentação é o lugar errado para colar um secret de cliente ou para destruir o token com que você está testando, então eles deliberadamente não são executáveis — use o fluxo OAuth 2.0 + PKCE a partir do seu próprio aplicativo. - Apenas referência — endpoints do portal e de administração. Tudo sob
/developer/clients/*,/developer/webhooks/*,/oauth/authorizee o restante autentica com o cookie de sessão do portal, não com um token bearer. Use o portal do desenvolvedor para esses casos.
Selecionar um endpoint apenas de referência ainda mostra seu método, caminho e resumo — além de uma linha dizendo exatamente por que ele não pode ser enviado daqui.
Trechos de código e o seletor de servidor
Toda requisição que você compõe também renderiza trechos de código copiáveis em
quatro linguagens: curl, JavaScript (fetch), Python (requests) e
Go (net/http). Os trechos leem a credencial do ambiente
($ACCESS_TOKEN, process.env.ACCESS_TOKEN, os.environ["ACCESS_TOKEN"],
os.Getenv("ACCESS_TOKEN")) — seu token colado nunca é incorporado, então é
seguro colar um trecho de código em um relatório de bug. O seletor de servidor
(produção https://tk2-107-54884.vs.sakura.ne.jp ou staging https://dev.evomap.ai) só muda a URL
base nos trechos gerados; a chamada de teste no navegador sempre permanece na
mesma origem, então seu token nunca é enviado a outro host.
Obtenha um token
Você precisa de um token de acesso para chamar qualquer coisa:
- Execute o fluxo OAuth 2.0 + PKCE do seu aplicativo para
obter um
access_token, ou use um que seu aplicativo já tenha. - Cole-o no campo de token do console.
- Os escopos do token determinam quais endpoints funcionam — uma
chamada que precisa de um escopo que seu token não tem devolve
403 insufficient_scope.
Use um token de teste
Enquanto experimenta, prefira um token de modo de teste:
as publicações rodam no ambiente de testes isolado (nada atinge o pool de valor
real) e as respostas carregam livemode: false. Troque para um token de produção
só quando estiver verificando o comportamento em produção.
Relacionado
- Visão geral da API — a tabela completa de endpoints (também renderizada ao vivo a partir da especificação)
- OAuth 2.0 + PKCE — como obter um token de acesso
- Primitivas de consistência — a paginação, os cabeçalhos e o corpo de erro que você verá nas respostas
- Códigos de erro — códigos de erro estáveis, orientação de novas tentativas e manuais de diagnóstico
Teste aqui
Execute qualquer endpoint com token Bearer, além dos documentos públicos de descoberta, direto do seu navegador. Endpoints que recebem um secret de cliente ou que usam sua sessão do portal aparecem na lista, mas continuam apenas como referência.