Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Os portais do desenvolvedor com recursos de publicação social estão sendo usados cada vez mais para se comunicar com a comunidade de desenvolvedores. 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.
Como provedor de API, você precisa de uma maneira de expor suas APIs, educar os desenvolvedores sobre elas, fazer a inscrição de desenvolvedores e permitir que eles registrem apps. Expor suas APIs aos desenvolvedores é apenas parte da criação de uma comunidade verdadeiramente dinâmica. Você também precisa de uma maneira para que sua comunidade de desenvolvedores envie feedback, faça solicitações de suporte e de recursos e envie o próprio conteúdo que pode ser acessado por outros desenvolvedores.
O Apigee Edge oferece um portal de serviços para desenvolvedores que pode ser usado para criar e lançar seu próprio site personalizado e oferecer todos esses serviços à sua comunidade de desenvolvimento. Todos os clientes do Edge podem criar o próprio portal do desenvolvedor, na nuvem ou no local.
O vídeo a seguir apresenta o portal de serviços para desenvolvedores da Apigee.
A figura a seguir mostra a página inicial do portal de desenvolvedor padrão:
O portal do desenvolvedor é basicamente um sistema de gerenciamento de conteúdo (CMS) baseado no projeto Drupal de código aberto (http://www.drupal.org). O Drupal oferece um conjunto de recursos principais na forma de módulos que facilitam a criação do conteúdo e o gerenciamento de sites.
O portal do desenvolvedor pronto para uso permite criar documentação da API, aceita blogs e disponibiliza fóruns baseados em tópicos. Também é possível personalizar o portal para atender aos seus requisitos específicos. A personalização permite modificar a aparência do portal e também a forma como os desenvolvedores interagem com ele.
Você usa o menu do Drupal para realizar a maioria das personalizações. Se você fizer login no portal como um usuário com privilégios de administrador, o menu do Drupal vai aparecer na parte de cima de cada página do portal:
A administração controla o processo em que os desenvolvedores solicitam acesso ao portal, como os desenvolvedores registram os apps que acessam suas APIs, como você atribui papéis e permissões específicos relacionados às suas APIs e quando revogar o acesso dos desenvolvedores às APIs.
Você também usa o portal do desenvolvedor para configurar e controlar a monetização. A monetização oferece aos desenvolvedores acesso de autoatendimento a "Faturamento e relatórios", "Catálogo e planos" e configurações específicas de monetização no portal do desenvolvedor.
Tipos de usuários do portal
A imagem a seguir mostra dois tipos de usuários do portal:
- Os desenvolvedores formam a comunidade de usuários que criam apps usando suas APIs. Os desenvolvedores de apps usam o portal para aprender sobre suas APIs com o SmartDocs, registrar uma conta no portal, registrar apps que usam suas APIs, interagir com a comunidade de desenvolvedores e conferir informações estatísticas sobre o uso do app em um painel.
-
A equipe de API é o provedor de API que cria o conteúdo do portal, disponibiliza as APIs
aos desenvolvedores de apps, oferece documentação de API e um mecanismo para
os desenvolvedores registrarem apps e receberem chaves de API. A equipe da API realiza a configuração básica do
portal do desenvolvedor para:
- Configurar solicitações automáticas ou manuais para chaves de API
- Manter a documentação, os fóruns e os blogs da API e revisar todas as mudanças, se necessário
- Gerenciar comentários de usuários e moderação de fóruns
- Aplique o controle de acesso baseado em função (RBAC) para controlar o acesso aos recursos no portal. Por exemplo, um administrador pode ativar controles para permitir que um usuário registrado crie postagens no fórum ou use consoles de teste.
- Personalizar notificações por e-mail para administradores e desenvolvedores para criação e aprovações de usuários
- Personalizar formulários da Web, como páginas de contato
Não mostrado nesta figura, um terceiro tipo de usuário do portal é o administrador de produtos de API. O gerente de produto de API é responsável por definir como a equipe de API constrói o portal, incluindo:
- Como definir como as APIs são empacotadas em produtos
- Definir as regras de aprovação de apps
- Se a monetização estiver ativada no portal, defina os planos de preços e faturamento para os produtos de API. Para mais informações sobre a monetização, consulte Visão geral da monetização.
Personalizar o portal do desenvolvedor
Como provedor de API, considere como personalizar o portal do desenvolvedor para que ele se encaixe melhor nas suas APIs e forneça as informações necessárias para que a comunidade de desenvolvedores use as APIs. Algumas considerações para seu portal personalizado incluem:
- Acesso fácil às suas APIs
- Documentação, como guias de instruções e documentos de referência
- Conteúdo gerado pela comunidade, como blogs e fóruns de discussão
- Código de amostra
- Um processo de inscrição fácil em que novos desenvolvedores, apps e APIs podem ser aprovados rapidamente
- Direitos e credenciais gerenciados
- Controle de acesso em camadas
- Um visual que combine com sua organização
O portal vem predefinido com uma configuração básica. Por exemplo, o portal está configurado para permitir que qualquer pessoa se registre como desenvolvedor, mas um administrador precisa aprovar cada registro antes que o desenvolvedor possa fazer login no portal. Após a aprovação do registro, o desenvolvedor pode registrar um app para solicitar uma chave de API e usar o portal para acessar os recursos da API.
As etapas do processo de registro padrão são as seguintes:
- O desenvolvedor faz o registro no portal do desenvolvedor. Em resposta, o portal envia um e-mail aos administradores para aprovar a conta.
- Um administrador aprova a conta, e um e-mail é enviado ao desenvolvedor informando que ele pode fazer login.
- O desenvolvedor registra um app e seleciona os produtos de API usados por ele. Em resposta, o portal atribui uma chave de API exclusiva ao app.
- O desenvolvedor transmite a chave de API ao fazer solicitações para sua API.
Essa experiência pronta para uso é altamente personalizável. Por exemplo, é possível substituir o esquema de registro e autorização padrão para que um novo desenvolvedor seja aprovado automaticamente e faça login após o registro. Ou você pode exigir que o desenvolvedor aceite um conjunto de Termos e Condições antes de fazer login pela primeira vez.
Você também tem controle total sobre o conteúdo disponível no portal para desenvolvedores. O portal do desenvolvedor apresenta conteúdo de exemplo, como documentação da API, postagens de blog e discussões em fóruns. Você pode fornecer seu próprio conteúdo e personalizar a aparência de cada tipo de conteúdo.
Para mais informações, consulte Personalizar a aparência.
Como administrar o portal do desenvolvedor
Os desenvolvedores usam o portal do desenvolvedor para acessar e usar a API. Os administradores realizam tarefas de gerenciamento de conta, como:
- Personalizar o processo de registro do desenvolvedor, incluindo campos de registro, captcha integrado e aprovação automática ou manual
- Adicionar ou aprovar desenvolvedores. Por padrão, qualquer desenvolvedor pode se registrar pelo portal do desenvolvedor, mas precisa ser aprovado por um administrador pela interface usuário do portal do desenvolvedor. Os administradores também podem criar desenvolvedores diretamente no portal. O portal envia automaticamente um e-mail ao desenvolvedor informando que uma conta foi criada para ele.
- Modificar a conta de um desenvolvedor. Por exemplo, os administradores podem mudar o status da conta do usuário de "Ativo" para "Bloqueado" ou alterar as informações do perfil do desenvolvedor, como o nome da empresa.
- Remover um desenvolvedor. Os administradores podem desativar ou excluir a conta de um desenvolvedor.
- Atribuição de papéis e permissões: os administradores podem atribuir um papel específico a uma conta de desenvolvedor. Uma função é associada a várias permissões, como a permissão para criar livros ou outro conteúdo. Também é possível mudar as permissões associadas a um papel ou criar novos papéis.
Para mais informações, consulte Adicionar e gerenciar contas de usuário.
Resumo dos recursos do portal do desenvolvedor
A tabela a seguir contém um resumo dos recursos do portal do desenvolvedor:
| Recurso | Detalhes |
|---|---|
| Suporte ao navegador |
Consulte Software e versões compatíveis. |
|
Registro de usuários |
|
|
Gerenciamento de usuários |
|
|
Aparência do portal |
|
|
Gerenciamento de conteúdo e comunidade |
|
|
Permissões |
|
|
Gerenciamento de chaves de API |
|
|
|
|
|
Blogs |
|
|
Fóruns |
|
|
Documentação |
|
|
Menus |
|
|
Pesquisar |
|
|
Verificador de links |
|