Criando um Produto de rascunho

Editar online

Crie um Produto de rascunho para coletar um conjunto de APIs e Planos em uma oferta a ser disponibilizada para os desenvolvedores. Um Plano inclui configurações de limite de taxa que podem ser aplicadas no Plano como um todo, ou especificadas para cada operação em uma API. Por meio de Produtos e Planos, você tem um controle maior sobre em quais APIs os desenvolvedores possuem acesso e os prazos de assinatura.

Antes de Iniciar

Defina suas APIs. Para obter mais informações, consulte “Criação de uma definição de API ”.
Dica: além de usar o método descrito nesta tarefa, também é possível criar um Produto ao criar uma API. Ao criar uma API utilizando o editor de linha de comandos do kit de ferramentas do desenvolvedor, um Produto será automaticamente criado para você. Em seguida, será possível mudar qualquer configuração do produto abrindo seu novo produto na página Produtos do API Designer.

Sobre essa tarefa

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

Ao criar o Produto pela primeira vez, ele tem o status rascunho. Ao concluir a configuração do Produto de rascunho, ele está preparado para um Catálogo, para que as APIs no Produto possam ser disponibilizadas para os desenvolvedores de aplicativos.

Procedimento

Para criar um Produto, conclua as etapas a seguir:
  1. No painel de navegação, clique em Desenvolver ícone na área de janela de navegação da UI da API Desenvolver, selecione a guia Produtos e, em seguida, clique em Adicionar > Produto.
    A página Incluir produto é aberta.
  2. Selecione Novo Produto, em seguida, clique em Avançar.
  3. Na página Informações , conclua as seguintes etapas:
    1. Insira Título e Versão do Produto e, opcionalmente, uma descrição. Um Nome é inserido automaticamente.
      Nota: o valor no campo Nome é uma sequência única que é usada para identificar o Produto nos comandos da CLI do developer toolkit . O Título é usado para exibição..

      Para ver os comandos da CLI para gerenciar produtos em rascunho, consulte a documentação de referência da CLI do kit de ferramentas.

    2. Clique em Avançar.
  4. Na página APIs , selecione as APIs que você deseja incluir no Produto. Para o ambiente de teste, você pode incluir apenas APIs cujo tipo de gateway corresponda ao tipo de gateway do produto, ou APIs para as quais a opção “Obrigatório” esteja desativada. As APIs para as quais a opção "Obrigatório" está desativada não são gerenciadas no API Connect gateway. Se você selecionar uma API incompatível cujo tipo de gateway não corresponde ao tipo de gateway do Produto, uma mensagem de aviso será exibida e não será possível salvar suas mudanças até você limpar a seleção incompatível. Para obter mais informações sobre tipos de gateway, consulte API Connect Tipos de gateway, Especificando o tipo de gateway para um produto e Especificando o tipo de gateway para uma definição de API.
  5. Clique em Avançar.
  6. Na página Planos , conclua as etapas a seguir:
    1. Opcional: altere as configurações de Título, Descrição ou Limite de taxa do plano padrão.
    2. Opcional: para adicionar outros planos, clique em “Adicionar”, role a página para baixo e altere as configurações do plano conforme necessário.
    3. Clique em Avançar.
  7. Para que o Produto seja publicado no Catálogo do Ambiente de simulação automaticamente após a criação, selecione Publicar produto.
    Nota: a opção de publicação não está disponível na IU do API Designer .
  8. Se Publicar produto for selecionado, será possível selecionar em qual serviço de gateway o Produto é publicado.. Por padrão, o Produto é publicado em todos os serviços de gateway relevantes
  9. Na seção Visibilidade, especifique os usuários para os quais você deseja que o Produto fique visível. É possível escolher Público para tornar o Produto visível para todos os usuários, Autenticado para tornar o Produto disponível para os usuários que foram autenticados com sucesso ou Customizado para especificar as organizações do consumidor e os grupos de organizações do consumidor para os quais você deseja que o Produto fique visível.

    Se você selecionar Customizado, use o campo Tipo para incluir organizações para procurar as organizações do consumidor e os grupos de organizações do consumidor que podem assinar os Planos no Produto. Para obter informações sobre como criar e gerenciar organizações de consumidores e grupos de organizações de consumidor, consulte Administrando organizações de consumidores

    A visibilidade também pode ser configurada no nível Catálogo ou Espaço. Para obter mais informações, consulte Configurando a visibilidade do produto em um catálogo.

  10. Na seção Assinatura , especifique os usuários que podem assinar os Planos no Produto. É possível escolher Autenticado para tornar os Planos no Produto assináveis por usuários que foram autenticados com sucesso ou Customizado para especificar as organizações do consumidor e os grupos de organizações do consumidor que podem assinar os Planos no Produto.
    Se você selecionar Customizado, use o campo Tipo para incluir organizações para procurar as organizações do consumidor e os grupos de organizações do consumidor que podem assinar os Planos no Produto. Se você selecionou a visibilidade customizada, somente as organizações do consumidor e os grupos de organizações do consumidor selecionados ali estarão disponíveis para inclusão na lista de capacidade de assinatura customizada. Para obter informações sobre como criar e gerenciar organizações de consumidores e grupos de organizações de consumidor, consulte Administrando organizações de consumidores
    Nota: se você selecionar visibilidade ou capacidade de assinatura customizada, as organizações de consumidores e os grupos de organizações de consumidores que podem ser escolhidos serão aqueles no Catálogo do Sandbox para o servidor de gerenciamento e a organização do provedor aos quais você está conectado. Se desejar especificar organizações de consumidores ou grupos que estejam em outro Catálogo ou em um Espaço, publique o Produto nesse Catálogo ou Espaço e, em seguida, configure a visibilidade ou a capacidade de assinatura lá; para obter detalhes, consulte Mudando a disponibilidade de um produto.

    Se você estiver usando a interface de usuário do API Manager, os detalhes da conexão serão determinados pelo API Manager URL que você abrir e pelo ID de usuário com o qual fizer login. Se você estiver usando a interface do usuário do API Designer, forneça os detalhes do servidor de gerenciamento e o ID de usuário na janela de login que se abre ao iniciar o API Designer pela primeira vez; consulte “Como fazer login no API Designer ”.

    Se você estiver trabalhando offline no API Designer, você deve digitar o nome exato da organização ou grupo.

    Para obter mais informações sobre organizações de consumidores em um Catálogo, consulte Administrando organizações de consumidores.

  11. Clique em Avançar para criar seu Produto.
    1. Para configurar ainda mais seu Produto, clique em Editar Produto.
      Para obter detalhes, consulte Edição de um rascunho de produto
    2. Se você não desejar configurar seu Produto ainda mais neste momento, clique no link inicial Desenvolver na trilha de navegação para retornar à página Desenvolver ; é possível, então, mover imediatamente para outra tarefa
      Para obter detalhes sobre como configurar seu produto posteriormente, consulte Edição de um rascunho de produto.

Resultados

Você criou um Produto de rascunho e especificou um conjunto de APIs e Planos em uma oferta que agora pode ser disponibilizada para os desenvolvedores.

O quê fazer em seguida

Prepare seu produto para um catálogo. Para obter mais informações, consulte Preparação de um rascunho de produto.