Skip to main content
API v1 Toda esta documentação nasce de uma spec OpenAPI 3.1, e ela é pública: dá para importar a API inteira no seu cliente favorito em um clique. A spec fica servida junto com o site, no caminho /api-reference/openapi.json. Monte a URL completa adicionando o caminho ao endereço desta documentação (o mesmo domínio desta página).

​
Postman

  1. Clique em Import e cole a URL da spec na aba Link.
  2. O Postman cria a coleção com todos os endpoints, parâmetros e exemplos.
  3. Na coleção, abra a aba Authorization: tipo API Key, Key Authorization, Value com o seu token v1, Add to Header.
  4. Pronto: toda requisição da coleção sai autenticada.

​
Insomnia

  1. Create > Import From > URL e cole a URL da spec.
  2. No ambiente da coleção, defina o cabeçalho Authorization com o seu token.

​
Direto no navegador

Sem instalar nada: cada página de endpoint na aba Referência da API tem um playground embutido. Informe o token no campo de autenticação e envie a chamada dali mesmo.
Em qualquer ferramenta, o token continua sendo uma senha: use um token de testes, não compartilhe coleções exportadas com o token salvo e revogue tokens que saírem do seu controle, como orienta o guia de Autenticação.

​
Próximos passos

Referência da API

Os endpoints com playground, sem sair do navegador.