Soluções do portal do desenvolvedor

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

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 apps 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

A Apigee é compatível com várias soluções de portal do desenvolvedor, resumidas na tabela a seguir, que vão de 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 Apigee Recursos Hospedado pela Apigee? Suporte
(requer assinatura licenciada)
Portal integrado da Apigee Desenvolvimento de portal de autoatendimento simples. Sim Suporte da Apigee 24 horas por dia, 7 dias por semana
Módulos do Drupal 8/9 Opção totalmente personalizável e baseada em um CMS eficiente e de código aberto, integrado por módulos à Apigee. Não Suporte da Apigee 24 horas por dia, 7 dias por semana para problemas de interrupção/correção
Faça você mesmo (DIY, na sigla em inglês) Desenvolvimento de portal totalmente personalizável usando as APIs da Apigee. Não Suporte da Apigee 24 horas por dia, 7 dias por semana, exclusivo para APIs 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.

Fluxograma mostrando as seleções para o portal integrado Drupal ou Apigee

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.

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
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

Criar um portal integrado

Crie rapidamente um portal de desenvolvedor leve na IU da Apigee. Acesse https://apigee.google.com/edge, faça login e selecione Publicar > Portais na barra de navegação lateral da IU híbrida. Para detalhes completos, consulte Criar seu portal integrado.

A figura a seguir mostra a página de destino para o portal integrado.

Introdução ao portal

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 híbrido é compatível com o Drupal 8 e 9, que fornece um sistema de gerenciamento de conteúdo (CMS, na sigla em inglês) no nível da empresa, de código aberto e confiável. Como o Drupal 8/9 tem código aberto, é possível estender e contribuir com o framework de desenvolvimento do portal Drupal 8/9 e aproveitar os conhecimentos da comunidade do Drupal. Para mais informações, consulte Criar seu portal usando o Drupal 8/9.

Criar seu próprio portal usando as APIs da Apigee

Crie seu próprio portal totalmente personalizado, utilizando as APIs da Apigee resumidas na tabela a seguir. Para mais informações, consulte as seções descritas na tabela a seguir.

Categoria APIs Apigee Descrição
Analytics Estatísticas (em inglês) Veja análise das suas APIs.
Chaves de API Chaves de app do 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

Apps para desenvolvedores

Gerencie os aplicativos registrados pelos desenvolvedores para consumir suas APIs.
Desenvolvedores Desenvolvedores Gerencie os desenvolvedores que se registraram no portal.

Simplifique a integração do cliente do portal usando a biblioteca de cliente da Apigee 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: