Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Portais de desenvolvedores com recursos de publicação em redes sociais são cada vez mais usados para comunicação com a comunidade de desenvolvedores. Isso inclui a comunicação de conteúdo estático, como a documentação e os Termos de Uso da API, além de conteúdo dinâmico criado pela comunidade, como blogs e fóruns.
Como provedor de API, você precisa de uma maneira de expor APIs, informar os desenvolvedores sobre elas, inscrever desenvolvedores e permitir que eles registrem apps. A exposição das suas APIs aos desenvolvedores é apenas parte da criação de uma comunidade realmente dinâmica. Você também precisa de uma maneira para que sua comunidade de desenvolvedores forneça feedback, faça solicitações de suporte e recursos e envie seu 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 fornecer todos esses serviços à sua comunidade de desenvolvedores. Cada cliente do Edge pode criar o próprio portal do desenvolvedor, seja 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 do desenvolvedor padrão:
O portal do desenvolvedor é essencialmente um sistema de gerenciamento de conteúdo (CMS, na sigla em inglês) baseado no projeto de código aberto Drupal (http://www.drupal.org). O Drupal oferece um conjunto principal de recursos na forma de módulos que facilitam a criação e o gerenciamento de conteúdo de sites.
O portal do desenvolvedor pronto para uso permite criar documentação de API, oferece suporte a blogs e oferece fóruns de tópicos. Também é possível personalizar o portal do desenvolvedor para atender aos seus requisitos específicos. A personalização permite modificar a aparência do portal e também a maneira como os desenvolvedores interagem com ele.
O menu do Drupal é usado para realizar a maior personalização. Se você fizer login no portal como um usuário com privilégios de administrador, o menu Drupal será exibido na parte superior de todas as páginas do portal:
A administração controla o processo em que os desenvolvedores solicitam acesso ao portal, como eles registram os apps que acessam suas APIs, como você atribui funções e permissões específicas aos desenvolvedores relacionadas às APIs e quando revogar o acesso do desenvolvedor às APIs.
Também é possível usar esse portal para configurar e controlar a monetização. Com a monetização, os desenvolvedores têm acesso de autoatendimento a faturamentos e relatórios, catálogos e planos e configurações específicas de monetização pelo portal do desenvolvedor.
Tipos de usuários do portal
A imagem a seguir mostra dois tipos de usuários do portal:
- Os desenvolvedores compõem a comunidade de usuários que criam apps usando suas APIs. Os desenvolvedores de apps usam o portal para saber mais sobre suas APIs por meio do SmartDocs, registrar uma conta no portal, registrar apps que usam suas APIs, interagir com a comunidade de desenvolvedores e visualizar informações estatísticas sobre o uso do aplicativo em um painel.
-
A equipe da API é o provedor de API que cria o conteúdo do portal, disponibiliza as APIs
para desenvolvedores de apps, fornece a documentação da API e disponibiliza um mecanismo para
que os desenvolvedores registrem apps e recebam chaves de API. A equipe de API executa a configuração básica do
portal do desenvolvedor para:
- Configure solicitações automáticas ou manuais para chaves de API
- Manter a documentação da API, fóruns e blogs e, opcionalmente, revisar todas as alterações
- Lidar com 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 do 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
- Personalize 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
A figura não mostra um terceiro tipo de usuário do portal: o gerenciador de produtos de API. O gerente de produto da API é responsável por definir como a equipe da API cria o portal, incluindo:
- Como definir como as APIs são empacotadas nos produtos
- Como definir as regras de aprovação do app
- Se a monetização estiver ativada no portal, definir os preços e os planos de faturamento dos produtos de API. Para saber mais sobre monetização, consulte Visão geral da monetização.
Como personalizar o portal do desenvolvedor
Como provedor de API, considere como personalizar o portal do desenvolvedor para melhor atender às suas APIs e fornecer as informações necessárias para que sua comunidade de desenvolvedores use suas APIs. Estas são algumas considerações para seu portal personalizado:
- Acesso fácil às APIs
- Documentação, como guias de instruções e documentos de referência
- conteúdo compartilhado pela comunidade, como blogs e fóruns de discussão;
- Exemplo de código
- 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 níveis
- Uma aparência que corresponda à sua organização
O portal vem predefinido com uma configuração básica. Por exemplo, o portal é configurado de imediato 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:
- O desenvolvedor se registra no portal. Em resposta, o portal envia um e-mail aos administradores para aprovar a conta.
- Um administrador aprova a conta, e um e-mail é enviado para o desenvolvedor informando que agora 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 a API.
Essa experiência pronta para uso é altamente personalizável. Por exemplo, é possível substituir o esquema padrão de registro e autorização para que um novo desenvolvedor seja automaticamente aprovado e conectado após o registro. Você também 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 do desenvolvedor. O portal do desenvolvedor apresenta exemplos de conteúdo prontos para uso, 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 para acessar e usar a API. Os administradores realizam tarefas de gerenciamento de conta, como:
- Personalização do processo de registro do desenvolvedor, incluindo campos de registro, integrados captcha e aprovação automática ou manual
- Adicionar ou aprovar desenvolvedores. Por padrão, qualquer desenvolvedor pode se registrar pelo portal, mas precisa ser aprovado por um administrador na interface do usuário do portal. Os administradores também podem criar desenvolvedores diretamente no portal. Em seguida, o portal vai enviar um e-mail automaticamente para o desenvolvedor informando que uma conta foi criada para ele.
- Modificar a conta de um desenvolvedor. Por exemplo, os administradores podem alterar o status da conta do usuário de ativa para bloqueada 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 funções e permissões: os administradores podem atribuir uma função específica a uma conta de desenvolvedor. Um papel está associado a várias permissões, como a para criar livros ou outro conteúdo. Também é possível alterar as permissões associadas a um papel ou criar novos.
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 chave de API; |
|
|
|
|
|
Blogs (links em inglês) |
|
|
Fóruns |
|
|
Documentação |
|
|
Menus |
|
|
Pesquisar |
|
|
Verificador de links |
|