Settings and Permissions (configurações e permissionamento)

Na aba Settings and Permissions, você pode:

  • Habilitar o registro de Apps e permitir que a API seja exibida no Catálogo.

  • Configurar a API para permitir que os desenvolvedores façam chamadas diretamente da documentação (tryout).

  • Definir os papéis (roles) para controle de acessos.

  • Escolher o ambiente para tryout.

aba Settings and Permissions

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

Veja como:

Acessando a aba Settings and Permissions

Siga estes passos para acessar a aba Settings and Permissions:

  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.

    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.

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

Papéis (roles)

Você pode definir um ou mais papéis que podem ter acesso à documentação da API listada em API Docs.

Siga estes passos para editar as permissões de roles:

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

  2. Encontre a API desejada e clique no ícone ícone de um lápis, na coluna ACTIONS.

  3. Clique na aba SETTTINGS & PERMISSIONS.

  4. No campo ROLES, selecione um ou mais papéis.
    Para ver a documentação da API, será necessário que o usuário tenha um desses papéis.
    Um usuário que tiver um papel que não está listado aqui, não poderá acessar a API.

tela api docs update com destaque para aba settings and permissions e para o campo roles

Selecione ambiente para tryout

Com o tryout, você pode fazer chamadas para a API diretamente da documentação. Veja como utilizar o tryout.

Para definir o ambiente para o tryout:

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

  2. Encontre a API desejada e clique no ícone ícone de um lápis, na coluna ACTIONS.

  3. Clique na aba SETTTINGS & PERMISSIONS.

  4. Clique no botão SELECT TRYOUT ENVIRONMENTS.

  5. Selecione um ou mais ambientes.

  6. Se desejar, você pode definir um ambiente padrão. Basta selecinar a oção na coluna DEFAULT.

Thanks for your feedback!
EDIT

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