Visão geral da publicação

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

A publicação é o processo de disponibilização das APIs para os desenvolvedores de apps para consumo.

Vídeo: apresenta a introdução de alto nível da publicação da API.

A publicação de APIs envolve as seguintes tarefas, descritas neste tópico:

  1. Crie os produtos de API no Edge que agrupam suas APIs.
  2. Registre desenvolvedores de apps no Edge.
  3. Registre apps de desenvolvedor no Edge.
  4. Fornecer documentação e suporte da comunidade para suas APIs.

Tarefa 1: criar um produto de API no Edge

A primeira tarefa na publicação é criar um produto de API. Um produto de API é um conjunto de recursos de API que é oferecido como um pacote para desenvolvedores de apps para consumo. Crie produtos de API usando a API ou a interface de gerenciamento do Edge. Consulte O que é um produto de API? para saber mais sobre os produtos de API.

Um diagrama de sequência da esquerda para a direita que mostra um desenvolvedor, um aplicativo, APIs e serviços de back-end. O ícone e os recursos da API são destacados. Uma linha pontilhada aponta do desenvolvedor para um ícone de um app que o desenvolvedor criou. Setas que saem do app e apontam de volta para o app mostram o fluxo de solicitação e resposta para um ícone de API, com uma chave de app posicionada acima da solicitação. O ícone e os recursos da API são destacados. Abaixo do ícone da API, há dois conjuntos de caminhos de recursos agrupados em dois produtos de API: produto de localização e produto de mídia. O produto de localização tem recursos para /países, /cidades e /idiomas, e o produto Media tem recursos para /livros, /revistas e /filmes. À direita da API estão os recursos de back-end que a API chama, incluindo um banco de dados, um barramento de serviço corporativo, servidores de aplicativos e um back-end genérico.

Nesta figura, a API consiste em dois produtos, cada um contendo três recursos de API.

Como provedor de APIs, você é responsável por criar as APIs e os produtos de API para lidar com controle de acesso, restrições de uso e quaisquer outros requisitos comerciais. Por exemplo, é possível:

  • Lançar um produto de API gratuito que permita acesso somente leitura aos recursos da API.
  • Lançar um segundo produto de API por um preço baixo que permite acesso de leitura/gravação aos mesmos recursos da API que a versão gratuita, mas com um limite de acesso baixo, como 1.000 solicitações por dia.
  • Lançar um terceiro produto de API por um preço mais alto que permite acesso de leitura/gravação ao mesmo recurso da API, mas com um limite de acesso alto.

É importante lembrar que o Edge oferece a flexibilidade de criar produtos de API que correspondam aos requisitos de negócios das suas APIs.

Para mais informações sobre como criar produtos de API, consulte Criar produtos de API.

Tarefa 2: registrar um desenvolvedor de apps no Edge

Um desenvolvedor cria os aplicativos que consomem suas APIs. Um desenvolvedor de apps é registrado no Apigee Edge antes de registrar o app. Ao registrar o app, ele recebe uma chave de API que dará ao app acesso à API.

Com o processo de registro de aplicativos, você controla quem tem acesso às suas APIs. A qualquer momento, é possível excluir um desenvolvedor de apps, que invalida todas as chaves de API associadas a ele, negando esse acesso às APIs.

Um diagrama de sequência da esquerda para a direita que mostra um desenvolvedor, um aplicativo, APIs e serviços de back-end. O ícone do desenvolvedor é destacado. Uma linha pontilhada aponta do desenvolvedor destacado para um ícone de um app que o desenvolvedor criou. Setas que saem do app e apontam de volta para o app mostram o fluxo de solicitação e resposta para um ícone de API, com uma chave de app posicionada acima da solicitação. Abaixo do ícone da API, há dois conjuntos de caminhos de recursos agrupados em dois produtos de API: produto de localização e produto de mídia. O produto de localização tem recursos para /países, /cidades e /idiomas, e o produto Media tem recursos para /livros, /revistas e /filmes. À direita da API estão os recursos de back-end que a API chama, incluindo um banco de dados, um barramento de serviço corporativo, servidores de aplicativos e um back-end genérico.

Como provedor de APIs, você decide como registrar desenvolvedores. Por exemplo, use um processo de registro manual que exige que um possível desenvolvedor entre em contato com sua organização para se registrar. O desenvolvedor em potencial precisa fornecer todas as informações necessárias, como um endereço de e-mail, nome e sobrenome e nome da empresa. Se você aprovar a solicitação do desenvolvedor, será possível usar a IU de gerenciamento do Edge para registrar o desenvolvedor manualmente. Consulte Como gerenciar desenvolvedores de apps para mais informações.

A Apigee também oferece ferramentas que podem ser usadas para automatizar o processo de registro de desenvolvedores. Exemplo:

  • Use a API de gerenciamento do Apigee Edge para integrar a funcionalidade de registro ao seu site. A API Edge Management é uma API REST que pode ser usada para executar todos os aspectos do processo de registro de desenvolvedores. Consulte Como usar a API Edge Management para publicar APIs e saber mais.
  • Use o portal de serviços para desenvolvedores da Apigee para registrar desenvolvedores. O portal tem suporte integrado para o registro de desenvolvedores, mas também tem muitos outros recursos para oferecer suporte às suas APIs. Consulte O que é um portal para desenvolvedores? para saber mais.

Tarefa 3: registrar um app de desenvolvedor no Edge

Antes de acessar as APIs, o app precisa estar registrado no Edge. No entanto, apenas um desenvolvedor registrado pode registrar um app no Edge.

Um diagrama de sequência da esquerda para a direita que mostra um desenvolvedor, um aplicativo, APIs e serviços de back-end. As setas de app, solicitação/resposta e chave de API são destacadas. Uma linha pontilhada aponta do desenvolvedor para um ícone de um app que o desenvolvedor criou. Setas que saem do app e apontam de volta para o app mostram o fluxo de solicitação e resposta para um ícone de API, com uma chave de app posicionada acima da solicitação. O ícone e os recursos da API são destacados. Abaixo do ícone da API, há dois conjuntos de caminhos de recursos agrupados em dois produtos de API: produto de localização e produto de mídia. O produto de localização tem recursos para /países, /cidades e /idiomas, e o produto Media tem recursos para /livros, /revistas e /filmes. À direita da API estão os recursos de back-end que a API chama, incluindo um banco de dados, um barramento de serviço corporativo, servidores de aplicativos e um back-end genérico.

No momento do registro do app, o desenvolvedor seleciona um ou mais produtos de API. Por exemplo, publique vários produtos de API correspondentes a diferentes tipos de serviços e planos de preços. O desenvolvedor do app pode escolher na lista de produtos de API disponíveis.

Em resposta ao registro do app no Edge, o Edge atribui uma chave de API exclusiva a ele. O app precisa transmitir essa chave de API como parte de cada solicitação para um recurso de API. A chave é autenticada e, se válida, a solicitação será concedida. A qualquer momento, você, como provedor de serviços, consegue revogar a chave para que o aplicativo não acesse suas APIs.

Como provedor de API, você decide como registrar apps. É possível:

  • Use um processo manual que exige que um desenvolvedor entre em contato com sua organização para registrar o app. Em resposta, você precisa enviar ao desenvolvedor a chave de API, possivelmente por e-mail.
  • Use a API Edge Management para integrar a funcionalidade de registro de apps e a entrega de chaves ao seu site.
  • Para uma conta paga do Edge, use o portal de serviços para desenvolvedores da Apigee, que tem suporte integrado para registro de apps e entrega de chaves de API.

Para mais informações, consulte Registrar aplicativos e gerenciar chaves de API.

Tarefa 4: documente suas APIs

Uma consideração importante para publicar produtos de API é fornecer documentação e um mecanismo de feedback do desenvolvedor. Os portais do desenvolvedor com recursos de publicação social estão sendo usados cada vez mais para se comunicar com a comunidade de desenvolvimento. Isso inclui a comunicação de conteúdo estático, como documentação e Termos de Uso da API, além de conteúdo dinâmico gerado pela comunidade, como blogs e fóruns, além de recursos de suporte ao cliente.

Um diagrama de sequência da esquerda para a direita que mostra um desenvolvedor, um aplicativo, APIs e serviços de back-end. O ícone do desenvolvedor é destacado. Abaixo do desenvolvedor há uma caixa que representa um portal de desenvolvedores. O portal contém documentação, exemplos e tutoriais da API, referência de API e outros. O portal também contém blogs, fóruns e um portal de suporte. Uma linha pontilhada aponta do desenvolvedor destacado para um ícone de um app que o desenvolvedor criou. Setas que saem do app e apontam de volta para ele mostram o fluxo de solicitação e resposta para um ícone de API, com uma chave de app posicionada acima da solicitação. Abaixo do ícone da API, há dois conjuntos de caminhos de recursos agrupados em dois produtos de API: produto de localização e produto de mídia. O produto de localização tem recursos para /países, /cidades e /idiomas, e o produto Media tem recursos para /livros, /revistas e /filmes. À direita da API estão os recursos de back-end que a API chama, incluindo um banco de dados, um barramento de serviço corporativo, servidores de aplicativos e um back-end genérico.

É possível criar seu próprio site para implantar a documentação ou, se você tiver uma conta do Edge paga, é possível usar o portal de serviços para desenvolvedores da Apigee. O portal tem suporte integrado para documentação, blogs, fóruns e outros tipos de conteúdo necessários para apoiar sua comunidade de desenvolvedores.

O SmartDocs permite documentar suas APIs no portal dos Serviços do desenvolvedor de um modo que torna a documentação da API totalmente interativa. A documentação interativa com o SmartDocs permite que os usuários do portal possam:

  • Ler sobre a API
  • Enviar uma solicitação em tempo real à API
  • Veja uma resposta em tempo real retornada da API

Por exemplo, a figura a seguir mostra uma API documentada no portal usando o SmartDocs. Essa API fornece informações sobre o clima em um local específico:

Um tópico de método da API SmartDocs que permite chamar uma API de clima clicando em um botão no tópico.

O desenvolvedor insere um valor para o parâmetro de consulta "w" para especificar o local e, em seguida, clica no botão Enviar a solicitação para conferir a solicitação e a resposta em tempo real. Ao criar uma documentação interativa nas suas APIs, você facilita o aprendizado, teste e avaliação das suas APIs para os usuários do portal.

A API de gerenciamento do Edge é uma API REST que permite acessar os serviços de API usando qualquer cliente HTTP. A Apigee usa o SmartDocs para criar documentação interativa para a API de gerenciamento do Edge. Consulte a documentação da API aqui.

Para mais informações, consulte Como usar o SmartDocs para documentar APIs.