Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
A publicação é o processo de disponibilização das suas APIs aos programadores de apps para consumo.
Vídeo: o vídeo seguinte apresenta uma introdução geral à publicação de APIs.
A publicação de APIs envolve as seguintes tarefas, descritas neste tópico:
- Crie os produtos de API que agrupam as suas APIs.
- Registar programadores de apps.
- Registe apps de programador.
- Disponibilizar documentação e apoio técnico da comunidade para as suas APIs.
Tarefa 1: crie um produto de API
A primeira tarefa na publicação é criar um produto de API. Um produto API é uma coleção de recursos de API que são oferecidos como um pacote aos programadores de apps para consumo. Crie produtos de API usando a API ou a IU do Apigee. (Consulte o artigo O que é um produto de API? para saber mais sobre os produtos de API.)
Nesta figura, a API é composta por dois produtos, cada um com três recursos de API.
Como fornecedor de APIs, é responsável pela criação das APIs e dos produtos de API para processar o controlo de acesso, as restrições de utilização e quaisquer outros requisitos empresariais. Por exemplo, pode:
- Lançar um produto de API gratuito que permita o acesso só de leitura aos respetivos recursos de API.
- Lançar um segundo produto de API por um preço baixo que permita o acesso de leitura/escrita aos mesmos recursos de API que a versão gratuita, mas com um limite de acesso baixo, como 1000 pedidos por dia.
- Lançar um terceiro produto de API a um preço mais elevado que permita o acesso de leitura/escrita ao mesmo recurso de API, mas com um limite de acesso elevado.
O importante a lembrar é que o Apigee lhe dá a flexibilidade de criar produtos de API que correspondem aos requisitos empresariais das suas APIs.
Para mais informações sobre a criação de produtos de API, consulte o artigo Gerir produtos de API.
Tarefa 2: registe um programador de apps
Um programador cria as apps que consomem as suas APIs. Um programador de apps regista-se no Apigee antes de poder registar a sua app. Quando regista a app, recebe uma chave de API que dá à app acesso à API.
Através do processo de registo de apps, controla quem tem acesso às suas APIs. Em qualquer altura, pode eliminar um programador de apps, o que invalida todas as chaves da API associadas a esse programador, negando, assim, o acesso desse programador às suas APIs.
Enquanto fornecedor de APIs, decide como registar programadores. Por exemplo, pode usar um processo de registo manual que exija que um potencial programador contacte a sua organização para se registar. O potencial programador tem de fornecer todas as informações necessárias, como um endereço de email, o nome próprio e o apelido. Se aprovar o pedido do programador, pode usar a IU do Apigee para registar manualmente o programador. Consulte o artigo Registar programadores de apps para ver mais informações.
Tarefa 3: registe uma app de programador
Antes de uma app poder aceder às suas APIs, tem de estar registada. No entanto, apenas um programador registado pode registar uma app.
No momento do registo da app, o programador seleciona um ou mais produtos de API. Por exemplo, pode publicar vários produtos de API correspondentes a diferentes tipos de serviços e planos de preços. O programador de apps pode, em seguida, escolher na lista de produtos de API disponíveis.
Em resposta ao registo da app no Apigee, o Apigee atribui uma chave da API exclusiva à app. A app tem de transmitir essa chave da API como parte de cada pedido a um recurso da API. A chave é autenticada e, se for válida, o pedido é concedido. Em qualquer altura, enquanto fornecedor de serviços, pode revogar a chave para que a app deixe de poder aceder às suas APIs.
Enquanto fornecedor de APIs, decide como quer registar as apps. Pode:
- Usar um processo manual que exige que um programador contacte a sua organização para registar a respetiva app. Em resposta, envia a chave da API ao programador, possivelmente por email.
- Use a API Apigee para integrar a funcionalidade de registo de apps e a entrega de chaves no seu Website.
- Para uma conta da Apigee paga, use o portal de serviços para programadores da Apigee, que tem suporte integrado para o registo de apps e a entrega de chaves de API.
Para mais informações, consulte o artigo Registar apps e gerir chaves da API.
Tarefa 4: documente as suas APIs
Uma consideração importante para a publicação de produtos de API é fornecer documentação e um mecanismo de feedback dos programadores. Os portais para programadores com funcionalidades de publicação social são cada vez mais usados para a comunicação com a comunidade de programadores. Isto inclui a comunicação de conteúdo estático, como documentação de APIs e termos de utilização, bem como conteúdo dinâmico contribuído pela comunidade, como blogs e fóruns, e funcionalidades de apoio técnico.
Pode criar o seu próprio Website para implementar a documentação ou, se tiver uma conta do Apigee paga, pode usar o portal de serviços para programadores do Apigee. O portal tem suporte integrado para documentação, blogs, fóruns e outros tipos de conteúdo necessários para apoiar a sua comunidade de programadores.
O SmartDocs permite-lhe documentar as suas APIs no portal de serviços para programadores de uma forma que torna a documentação da API totalmente interativa. A documentação interativa com o SmartDocs significa que os utilizadores do portal podem:
- Leia sobre a API
- Envie um pedido em direto para a API
- Veja uma resposta em direto devolvida pela API
Para mais informações, consulte as secções seguintes:
- Portal integrado: publicar as suas APIs
- Drupal 10: documente as suas APIs