Introdução

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

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 Você é hospedado pela Apigee? Suporte
(requer uma assinatura licenciada)
Portal integrado da Apigee Desenvolvimento simples de portal de autoatendimento.
(Somente clientes da nuvem pública do Apigee Edge)
Sim Suporte 24 horas da Apigee
Portal do Drupal 9 Desenvolvimento de portal de autoatendimento totalmente personalizável usando projetos de código aberto Drupal 9. Integração com a Apigee usando o módulo do Apigee Edge. Não Suporte 24 horas da Apigee para problemas de correção
Portal personalizado Desenvolvimento de um portal do tipo "faça você mesmo" totalmente personalizável usando as APIs da plataforma Apigee. Não Suporte 24 horas da Apigee apenas para APIs da plataforma 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.

Diagrama de fluxo mostrando quando usar o Drupal e o portal integrado da Apigee

Se você for cliente do Apigee Edge para nuvem pública, crie um portal integrado da Apigee se quiser oferecer suporte a casos de uso comuns para o desenvolvimento do portal, como fluxos padrão de registro e criação de apps, e mais estilizados do que mudanças funcionais.

Os portais baseados no Drupal são a única opção no momento para o Apigee Edge para clientes de nuvem privada e de monetização.

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 usando Markdown ícone de seleção verde ícone de seleção verde
Desenvolvimento de conteúdo do portal usando HTML ícone de seleção verde ícone de seleção verde
Documento de referência da API renderizado pelas especificações da OpenAPI ícone de seleção verde ícone de seleção verde
Suporte à versão 3 da especificação OpenAPI ícone de seleção verde ícone de seleção verde
Enviar solicitações ativas da sua Referência de API ícone de seleção verde ícone de seleção verde
Tema personalizado ícone de seleção verde ícone de seleção verde
Menus personalizados ícone de seleção verde ícone de seleção verde
Tags de terceiros, como o Google Analytics ícone de seleção verde ícone de seleção verde
Código JavaScript personalizado ícone de seleção verde ícone de seleção verde
Nome do domínio personalizado ícone de seleção verde ícone de seleção verde
HTTPs ativados ícone de seleção verde ícone de seleção verde
Termos e Condições para criação de contas ícone de seleção verde ícone de seleção verde
Otimização da exibição em dispositivos móveis ícone de seleção verde ícone de seleção verde
Integração com scripts personalizados e tags de script ícone de seleção verde ícone de seleção verde
Configuração do SMTP ícone de seleção verde ícone de seleção verde
Configuração do modelo de e-mail ícone de seleção verde ícone de seleção verde
captcha para evitar spam ícone de seleção verde ícone de seleção verde
Funções e permissões para contas de desenvolvedor/consumidor ícone de seleção verde ícone de seleção verde
Login federado ícone de seleção verde ícone de seleção verde
APIs de gerenciamento de conteúdo Como usar o Drupal
Monetização Em breve ícone de seleção verde
Configuração de pesquisa * ícone de seleção verde
Blog e fóruns ** ícone de seleção verde
Modelos de página para criação de conteúdo ícone de seleção verde
Análise de aplicativos no portal ícone de seleção verde
Gerenciamento de eventos com base em regras ícone de seleção verde
Extensível com módulos complementares ícone de seleção verde
Fluxos de registro de apps personalizados ícone de seleção verde
Fluxos de registro de desenvolvedor personalizados ícone de seleção verde
Registros do portal ícone de seleção verde
Verificador de links ícone de seleção verde
Compatibilidade com o Microsoft Internet Explorer/Microsoft Edge Somente Microsoft Edge ícone de seleção verde
Suporte da Apigee Consulte a tabela acima Consulte a tabela acima

Criar um portal integrado

Se você é cliente do Apigee Edge para nuvem pública, pode criar rapidamente um portal do desenvolvedor leve na IU do Edge. Navegue até https://apigee.com/edge, faça login e selecione Publish > Portals 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.

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 Apigee Edge é compatível com as seguintes versões do Drupal:

Versão Descrição
Drupal 9 Fornece um sistema de gerenciamento de conteúdo (CMS) confiável, gerenciado pelo cliente e de código aberto. Como o Drupal 9 tem código aberto, é possível ampliar e contribuir com o framework de desenvolvimento do portal Drupal 9 e aproveitar os conhecimentos da comunidade do Drupal. Para mais informações, consulte Criar seu portal usando o Drupal 9.

Crie um portal personalizado usando as APIs Apigee Edge

Crie seu próprio portal totalmente personalizado utilizando as APIs da Apigee Edge. Resumo na tabela a seguir. Veja mais informações nos links abaixo:

Categorias APIs Apigee Descrição
Analytics Estatísticas (em inglês) Veja as análises das suas APIs.
Chaves de API Chaves do app: desenvolvedor

Chaves de app: empresa

Gerencie as chaves de API usadas para autorizar o uso de APIs em apps.
Produtos de API Produtos de API Gerencie os produtos de API que você publica no portal do desenvolvedor.
Aplicativos Apps

Aplicativos: desenvolvedor

Apps: Empresa

Gerencie os aplicativos registrados por desenvolvedores para consumir suas APIs.
Desenvolvedores Desenvolvedores

Empresas

Desenvolvedores da empresa

Gerencie os desenvolvedores que se registraram no seu 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: