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 da sua API, a documentação é carregada automaticamente, mas você também pode adicioná-la (assim como editar e excluir) em API DOCS.

Veja abaixo como configurar os produtos.

Lista de produtos cadastrados

Na lista de produtos cadastrados você encontra as colunas:

  • Name: nome dado ao produto no momento do cadastro;

  • Description: texto descritivo do produto, informado no momento do cadastro;

  • API: APIs associadas ao produto;

  • Actions: a partir desta coluna, você pode editar, deletar e visualizar um produto, clicando no ícone respectivo.

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).

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, informe um nome e uma descrição para o produto e clique em NEXT.

  • No passo 2 APIS, comece a digitar o nome de uma API no campo Search for an API, selecione a API e clique em ADD.
    Repita até que todas as APIs para o produto tenham sido adicionadas e clique em NEXT.

  • Passo 3 REVIEW: confirme a lista de APIs e clique em SAVE.
    Caso a lista precise ser editada, clique em PREVIOUS e adicione ou remova uma ou mais APIs. Em seguida, clique em SAVE para salvar a alteração.

Editando um produto

Para alterar um produto, siga os passos a abaixo:

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

  2. Na tela seguinte você pode (mas não é obrigatório) editar nome e descrição do produto.
    Clique em NEXT para continuar.

  3. Na tela com a lista de APIs, adicione ou delete uma ou mais APIs.
    Para adicionar uma API, procure pelo seu nome, selecione e clique ADD.
    Para deletar, localize a API na lista e clique no ícone ícone com a imagem de uma lixeira. Clique em DELETE para confirmar.

  4. Clique no botão SAVE para salvar ou SAVE AS NEW VERSION para salvar como nova versão.

Thanks for your feedback!
EDIT
How useful was this article to you?