Visão geral da publicação

Você está vendo a documentação da Apigee X.
Ver a documentação da Apigee Edge

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. Criar os produtos de API que agrupam suas APIs.
  2. Registrar desenvolvedores de apps.
  3. Registrar apps de desenvolvedores.
  4. Fornecer documentação e suporte da comunidade para suas APIs.

Tarefa 1: crie um produto de API

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 IU da Apigee. 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 a Apigee 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 Como gerenciar produtos de API.

Tarefa 2: registrar um desenvolvedor de apps

Um desenvolvedor cria os aplicativos que consomem suas APIs. Um desenvolvedor de apps é registrado na Apigee 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 da Apigee para registrá-lo manualmente. Consulte Como registrar desenvolvedores de apps para mais informações.

Tarefa 3: registrar um app de desenvolvedor

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

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 a um registro de app na Apigee, a Apigee 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 da Apigee para integrar a funcionalidade de registro de apps e a entrega de chaves ao seu site.
  • Para uma conta paga da Apigee, 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 Como registrar apps e gerenciar chaves de API.

Tarefa 4: documentar 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 da Apigee 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
  • Visualizar uma resposta em tempo real retornada da API

Para mais informações, consulte as seguintes seções: