Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Como provedor de API, você desenvolveu um conjunto de APIs para fornecer acesso aos serviços de back-end. A próxima etapa é criar seu portal do desenvolvedor, para que os desenvolvedores de aplicativos possam:
- saber mais sobre suas ofertas de dados e serviços;
- saber como usar suas APIs consultando a documentação abrangente, incluindo exemplos de casos de uso, tutoriais e documentação de referência;
- Registrar-se usando um processo de autoatendimento para criar aplicativos que usam suas APIs
Visão geral das soluções do portal do desenvolvedor
A Apigee é compatível com várias soluções de portal do desenvolvedor, resumidas na tabela a seguir, que vão desde soluções simples até as totalmente personalizáveis e extensíveis. Ao escolher uma solução, você precisa equilibrar os requisitos de personalização com o tempo e o conhecimento necessários para implementar seu portal.
| Solução | Recursos | Hospedado pela Apigee? | Suporte (requer assinatura licenciada) |
|---|---|---|---|
| Portal integrado da Apigee | Desenvolvimento simples de portal de autoatendimento. (somente para clientes da nuvem pública do Apigee Edge) |
Sim | Suporte da Apigee 24 horas por dia, 7 dias por semana |
| Portal do Drupal 10 | Desenvolvimento de um portal de autoatendimento totalmente personalizável usando projetos de código aberto do Drupal 10. Integração com a Apigee usando o módulo Apigee Edge. | Não | Suporte da Apigee 24 horas por dia, 7 dias por semana para problemas de interrupção/correção |
| Portal personalizado | Desenvolvimento de portal totalmente personalizável usando as APIs da plataforma Apigee. | Não | Suporte da Apigee 24 horas por dia, 7 dias por semana, exclusivo para APIs da plataforma da Apigee |
Escolher sua solução do portal do desenvolvedor
Para escolher a melhor solução de portal do desenvolvedor, consulte a seguinte árvore de decisão e avalie a Comparação de recursos do portal do desenvolvedor.
Se você é cliente do Apigee Edge para nuvem pública, considere criar um portal integrado da Apigee se você planeja oferecer suporte a casos de uso comuns para o desenvolvimento do portal, como fluxos de registro padrão e de criação de aplicativos, e alterações mais de estilo do que funcionais.
No momento, os portais baseados no Drupal são a única opção para clientes de monetização e do Apigee Edge para nuvem privada.
Comparação de recursos do portal do desenvolvedor
A tabela a seguir fornece uma comparação dos recursos entre o portal integrado e o portal do desenvolvedor com base em Drupal da Apigee.
| Recurso | Portal integrado | Drupal |
|---|---|---|
| Desenvolvimento de conteúdo do portal com o Markdown |
|
|
| Desenvolvimento de conteúdo do portal com HTML |
|
|
| Documento de referência da API renderizado das especificações da OpenAPI |
|
|
| Compatibilidade com a versão 3 da especificação da OpenAPI |
|
|
| Enviar solicitações ao vivo a partir da referência da API |
|
|
| Tema personalizado |
|
|
| Menus personalizados |
|
|
| Tags de terceiros, como o Google Analytics |
|
|
| Código JavaScript personalizado |
|
|
| Nome do domínio personalizado |
|
|
| HTTPs ativados |
|
|
| Termos e Condições para criação de conta |
|
|
| Otimização da exibição em dispositivos móveis |
|
|
| Integração com scripts personalizados e tags de script |
|
|
| Configuração do SMTP |
|
|
| Configuração do modelo de e-mail |
|
|
| CAPTCHA para evitar spam |
|
|
| Funções e permissões para contas pessoais e de desenvolvedor |
|
|
| Login federado |
|
|
| APIs de gerenciamento de conteúdo | Como usar o Drupal | |
| Monetização | Em breve |
|
| Configuração da pesquisa | * |
|
| Blogs e fóruns | ** |
|
| Modelos de página para criação de conteúdo |
|
|
| Análise de aplicativos no portal |
|
|
| Gerenciamento de eventos com base em regras |
|
|
| Extensão com módulos complementares |
|
|
| Fluxos de registro de apps personalizados |
|
|
| Fluxos de registro de desenvolvedor personalizados |
|
|
| Registros do portal |
|
|
| Verificador de links |
|
|
| Compatibilidade com o Microsoft Internet Explorer/Microsoft Edge | Somente Microsoft Edge |
|
| Suporte da Apigee | Consulte a tabela acima | Consulte a tabela acima |
Criar um portal integrado
Se você for cliente do Apigee Edge for Public Cloud, poderá criar um portal de desenvolvedor leve rapidamente na interface do Edge. Acesse https://apigee.com/edge, faça login e selecione Publicar > Portais na barra de navegação lateral da interface do Edge. Para detalhes completos, consulte Criar seu portal integrado.
A figura a seguir mostra a página de destino para o portal integrado.
Criar um portal com base no Drupal
Com as ferramentas de desenvolvimento do portal Drupal, é possível construir um portal do desenvolvedor totalmente personalizável. O Drupal fornece um conjunto avançado de funcionalidades e todos os recursos CMS do Drupal com outros módulos do Drupal desenvolvidos pela Apigee. No entanto, a implementação de um portal com base no Drupal requer mais tempo e esforço.
O Apigee Edge é compatível com as seguintes versões do Drupal:
| Versão | Descrição |
|---|---|
| Drupal 10 | Oferece um sistema de gerenciamento de conteúdo (CMS) confiável, de código aberto e gerenciado pelo cliente. Como o Drupal 10 tem código aberto, é possível ampliar e contribuir com o framework de desenvolvimento do portal Drupal 10 e aproveitar os conhecimentos da comunidade do Drupal. Para mais informações, consulte Criar seu portal usando o Drupal 10. |
Criar um portal personalizado usando as APIs do Apigee Edge
Crie seu próprio portal totalmente personalizado usando as APIs do Apigee Edge resumidas na tabela a seguir. Confira mais informações em:
| Categorias | APIs Apigee | Descrição |
| Analytics | Estatísticas (em inglês) | Veja análise das suas APIs. |
| Chaves de API | Chaves de app: desenvolvedor | Gerencie chaves de API usadas para autorizar o uso de APIs em aplicativos. |
| Produtos de API | Produtos de API | Gerencie os produtos de API que você publica no portal do desenvolvedor. |
| Aplicativos | Apps | Gerencie os aplicativos registrados pelos desenvolvedores para consumir suas APIs. |
| Desenvolvedores | Desenvolvedores | Gerencie os desenvolvedores que se registraram no portal. |
| Monetização | Monetização | Gere receita com suas APIs. |
Simplifique a integração do cliente do portal usando a biblioteca de cliente do Apigee Edge para PHP. O SDK facilita a gravação de módulos PHP que usam as APIs da Apigee descritas na tabela anterior. Para mais informações sobre a biblioteca de cliente da API da Apigee para PHP, consulte: