General Info

Na aba General Info você pode:

General Info

Acessando a aba General Info

Siga estes passos para acessar a aba General Info:

  1. Acesse a página API DOCS, clicando no menu lateral esquerdo ou no card na tela inicial do Developer Portal.
    tela inicial com destaque para api docs

  2. Localize a API que deseja testar.
    Se necessário, utilize a ferramenta de busca.

  3. Na coluna ACTIONS da lista de APIs, clique em ícone de um lápis da API desejada.

Configurando credenciais

Para entrar com credenciais de acesso para a API:

  1. Acesse a aba General Info em API Docs.

  2. Clique em AUTHORIZE.
    aba general info com destaque para o botão authorize

  3. Informe o valor da chave.
    modal de autorizações disponíveis

Tryout

Este recurso permite que você faça chamadas para a API diretamente da documentação.

Com o tryout, você pode compreender como são os formatos das requisições e respostas e quais os parâmetros demandados por cada endpoint.

Veja como escolher o ambiente para tryout.

Siga estes passos para utilizar o tryout:

  1. Siga os passos para chegar na aba Settings and Permissions.

  2. Em Settings and Permissions, clique em SELECT TRYOUT ENVIRONMENT.
    botão para selecionar ambiente

  3. Na tela que abrir, escolha o ambiente da API que deseja testar.
    ambientes disponíveis

    Os ambientes disponíveis para tryout são nomeados de maneira padronizada, independentemente do provedor, com base nas especificações técnicas do contrato da API:

    • Para OpenAPI 3.x: as informações são obtidas dos campos servers.url (endereço) e servers.description (nome do ambiente).

    • Para Swagger 2.0: a URL é formada pela combinação dos campos scheme, host e basePath.

    Se o contrato não apresentar uma descrição explícita para o ambiente, o sistema utiliza o host da URL como identificador ou procura automaticamente por palavras-chave (como prod, dev ou test) para nomear o ambiente.

  4. Navegue pela documentação da API e clique em Try it out para fazer chamadas para os endpoints.

    botão para testar o endpoint

    Se necessário, clique em Authorize e insira as credenciais para acessar a API.

  5. Os resultados serão exibidos logo abaixo do endpoint. Veja um exemplo abaixo.

exemplo de resultado da chamada
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]