Products

Em Products você pode organizar as documentações das suas APIs de acordo com as funcionalidades próprias de cada produto.

Ao fazer a importação de uma API, a sua documentação é carregada automaticamente. Você também pode adicionar documentações manualmente. Para saber mais detalhes, consulte API DOCS.

Listagem de produtos cadastrados

Na lista de produtos cadastrados você encontra as colunas:

  • Product Name: nome dado ao produto;

  • Description: texto descritivo do produto;

  • Integration: informa qual das integrações é utilizado para o produto;

  • API: APIs associadas ao produto;

  • API Count: quantidade de APIs associadas ao produto;

  • Actions: clique no respectivo ícone para editar, deletar ou visualizar um produto.

tela com listagem de produtos

Localizando um produto

O campo de busca está localizado logo acima da lista de produtos.

Você pode buscar pelo produto pelo nome ou pela(s) API(s).

barra de busca

Visualizando os produtos

Para verificar o seu produto e certificar que as APIs correspondentes estão devidamente listadas, siga os passos abaixo:

  1. Acesse a tela Menu Principal  Products ou clique no card Products, na tela inicial do seu Dev Portal.

  2. Localize o produto que deseja visualizar e clique no ícone icone em forma de um olho.
    A tela seguinte exibirá nome do produto, descrição e suas APIs.
    Ao terminar, clique em CANCEL.

Cadastrando um produto

Siga os passos abaixo para cadastrar um produto:

  • Acesse a tela Menu Principal  Products ou clique no card Products, na tela inicial do seu Dev Portal.

  • Clique no botão + NEW PRODUCT.

  • Em 1 BASIC INFO, preencha os campos:

    • Product name: defina um nome para o produto.

    • Description: escreva uma descrição.

    • Roles: estabeleça um ou mais papéis.

    • Clique em NEXT.

      Para ter acesso ao produto, será necessário que o usuário possua um dos papéis listados neste campo.
      Um usuário que tiver um papel que não está listado no campo roles, não poderá acessar a API.

passo 1 do cadastro de um produto

  • No passo 2 APIS, escolha uma integração e adicione uma ou mais APIs.
    Para escolher a integração, selecione uma da lista disponível.
    Selecione a API desejada e clique em ADD API.
    Repita até que todas as APIs para o produto tenham sido adicionadas e clique em NEXT.

    Comece a digitar o nome da API para ver as opções disponíveis

passo 2 do cadastro de um produto

  • Passo 3 REVIEW: confirme as informações e clique em SAVE.
    Caso precise editar algo, clique em PREVIOUS.

passo 2 do cadastro de um produto

Editando um produto

Para alterar um produto, siga os passos a abaixo:

  • Em Products, localize o produto que deseja editar e clique no ícone ícone em forma de um lápis.

  • Em 1 BASIC INFO, você pode (mas não é obrigatório) editar nome e descrição do produto e os papéis que podem acessá-lo.

  • Clique em NEXT para continuar.

  • Passo 2 APIS: aqui você pode alterar a integração e adicionar ou deletar uma ou mais APIs.
    Para adicionar uma API, comece a digitar seu nome, selecione e clique ADD API.
    Para deletar, localize a API na tabela e clique no ícone ícone com a imagem de uma lixeira. Clique em REMOVE para confirmar.
    Clique em NEXT.

  • Passo 3 REVIEW: revise as informações e clique no botão SAVE para salvar ou PREVIOUS para voltar a editar.

Thanks for your feedback!
EDIT

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