API Settings

As documentações disponíveis em API DOCS podem ser configuradas em API Settings.

Na página de API Settings, você pode configurar a API para permitir que os desenvolvedores façam chamadas à API diretamente da documentação (tryout), habilitar o registro de Apps e permitir que a API seja exibida no Catálogo.

API Settings

Esta configuração está disponível apenas para APIs importadas automaticamente com a conexão.

Saiba mais sobre:

API Settings

Para acessar a tela API Settings, siga estes passos:

  1. Acesse o API DOCS, clicando no menu lateral esquerdo ou no card na tela inicial do Developer Portal.

  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.

    A coluna AVAILABILITY indica se:

    • ícone com um check a API está disponível para exibição no catalogo e para criação de apps;

    • ícone amarelo com a letra i a API não está disponível para exibição no catálogo ou (ou exclusivo) para criação de apps.

    • ícone vermelho com a letra i a API não está disponível para exibição no catálogo e (conjunção) para criação de apps.

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.

Siga estes passos para utilizar o tryout:

  1. Siga os passos acima para chegar na tela API Settings.

  2. Em API Settings, 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

  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.
    botão authorize

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

exemplo de resultado da chamada

Permitir o registro de Apps

Para permitir que os desenvolvedores registrem suas aplicações no Developer Portal, basta selecionar a opção Enable Apps Registration.

Mantenha o botão Enable Apps Registration desabilitado se quiser bloquear o registro de Apps.

localização do toggle para habilitar o registro de Apps

Esta opção está disponível apenas para APIs de conexões nativas.

Permitir a exibição da API no Catálogo

Para permitir que a API seja exibida no Catálogo, basta selecionar a opção Enable in Portal Catalog.

Se preferir que a API não seja exibida no Catálogo, mantenha o botão Enable in Portal Catalog desabilitado.

localização do toggle para habilitar a exibição da API no Catálogo

Thanks for your feedback!
EDIT

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