Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
Para registrar um novo app, o desenvolvedor seleciona o botão "Adicionar um novo app" na página "Meus apps".
O portal exibe o formulário de registro de app padrão:
Por padrão, o desenvolvedor só precisa especificar o nome do app, o URL de callback e a lista de produtos da API a serem adicionados ao app.
Como provedor de API, você tem controle total sobre o processo de registro do app. Por exemplo, você pode configurar:
- A lista de produtos de API disponíveis no portal
- Se há um produto de API padrão
- Se o URL de callback é obrigatório
- Se a chave de API é aprovada de modo manual ou automático para um produto de API
- Se alguma outra informação é necessária na página "Adicionar app" para registrar o app.
Este tópico descreve como configurar o processo de registro do app para seu portal. No entanto, este tópico não descreve como criar produtos de API. Para mais informações, consulte:
É possível configurar o portal para proibir que os desenvolvedores criem, excluam ou editem apps com base no papel atribuído a eles. Por exemplo, é possível configurar o portal para criar um único app padrão para todos os desenvolvedores quando eles se registrarem. Dessa forma, você só permite que alguns desenvolvedores adicionem novos apps, possivelmente com base em uma estrutura de taxas ou em outras características do desenvolvedor. Use papéis e permissões para controlar quais desenvolvedores podem criar, excluir e editar apps. Consulte Adicionar e gerenciar contas de usuário para mais informações.
Especificar os produtos da API disponíveis no portal
Há duas maneiras de especificar os produtos de API disponíveis quando um desenvolvedor acessa o portal:
- Como especificar o nível de acesso ao criar um produto de API
- Como restringir o acesso a um produto de API com base em papéis
Especificar o nível de acesso durante a criação de um produto de API
Ao criar um produto de API, você especifica a opção de nível de acesso do produto, como mostrado abaixo:
Para mais informações sobre como o nível de acesso afeta a disponibilidade do produto de API no portal do desenvolvedor do Drupal 7, consulte Nível de acesso.
Como restringir o acesso a um produto de API com base em papéis
Ao ativar o módulo Drupal de acesso ao papel de produto da API, você pode especificar os papéis que podem acessar cada produto de API.
Para restringir o acesso a um produto de API com base nas funções de desenvolvedor:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Revise os papéis do Portal do desenvolvedor e as atribuições de usuários:
- Selecione Pessoas > Permissões > Papéis no menu de administração do Drupal e adicione ou edite as funções e permissões de desenvolvedor, conforme necessário.
- Selecione Pessoas no menu de administração do Drupal e edite as atribuições de usuário e papel, conforme necessário.
- Selecione Configuração > Portal do desenvolvedor > Acesso ao papel do produto da API no menu de administração do Drupal.
- Selecione os papéis que terão acesso a cada produto de API.
- Clique em Salvar configuração.
Configurar como um desenvolvedor associa produtos de API a um app
Para registrar um novo app, o desenvolvedor seleciona o botão "Adicionar um novo app" na página "Meus apps" para abrir o formulário "Adicionar app":
Com base na configuração do portal, o desenvolvedor pode selecionar um ou mais produtos de API para associar ao app no momento do registro. Também é possível especificar um produto padrão atribuído a todos os apps.
As opções de configuração a seguir estão disponíveis no portal para controlar a seleção de produtos da API ao registrar um app:
- Não associe aplicativos a nenhum produto de API.
- Associar todos os aplicativos a um ou mais produtos de API padrão (configurados abaixo). Os desenvolvedores não podem adicionar outros produtos de API ao app.
- Permitir a seleção de um único produto de API, mas não exigir.
- Exige a seleção de um único produto de API.
- Permitir a seleção de vários produtos de API, mas não exigir nenhum.
- Permitir a seleção de vários produtos de API e exigir pelo menos um.
Também é possível controlar o elemento HTML que aparece no formulário usado pelo desenvolvedor para selecionar o produto da API. As opções incluem:
- Listas suspensas.
- Caixas de seleção ou botões de opção. As caixas de seleção aparecem quando o desenvolvedor pode selecionar vários produtos de API, e os botões de opção aparecem quando o desenvolvedor pode selecionar apenas um produto de API.
Para definir a opção de seleção de produtos da API:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Configuration > Dev Portal Settings > Application Settings no menu de administração do Drupal.
- Na página "Configurações do aplicativo", expanda a área Configurações do produto de API.
- Em Gerenciamento de produtos da API, selecione a opção que controla a seleção dos produtos da API.
- Se você especificar a opção "Associar todos os aplicativos a um ou mais produtos de API padrão (configurados abaixo)", defina um produto padrão em Produto de API padrão.
- Em Widget de produto de API, selecione o elemento HTML usado pelos desenvolvedores para selecionar os produtos de API.
- Salve a configuração.
Configurar o processamento do URL de callback
Se um proxy de API no seu produto de API usar o "OAuth de três etapas" (tipo de concessão de código de autorização), os desenvolvedores precisarão especificar um URL de callback ao registrarem os apps. O URL de callback normalmente especifica o URL de um app designado para receber um código de autorização em nome do app cliente. Além disso, essa string de URL é usada para validação. O cliente precisa enviar esse URL para o Apigee Edge ao solicitar códigos de autorização e tokens de acesso, e o parâmetro redirect_uri precisa corresponder ao que está registrado. Para ver mais informações, consulte Como implementar o tipo de concessão do código de autorização.
Para controlar o URL de callback da seleção de produtos da API:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Configuration > Dev Portal Settings > Application Attributes no menu de administração do Drupal.
- Na página "Configurações do aplicativo", expanda a área Configurações do URL de callback.
- Em Gerenciamento de URL de retorno, selecione uma das opções a seguir.
- O URL de retorno é obrigatório para todos os apps de desenvolvedor.
- O URL de callback é opcional para todos os apps de desenvolvedores.
- O URL de retorno não é obrigatório nem exibido.
- Salve a configuração.
Exibição de análises de uso do app
O portal pode exibir informações analíticas sobre o uso do app. Se a exibição de análises estiver ativada, os desenvolvedores de apps poderão vê-las na página "Meus apps" de cada app. Por exemplo, um desenvolvedor pode exibir as seguintes análises para um aplicativo:
- Capacidade de processamento
- Tempo máximo de resposta
- Tempo mínimo de resposta
- Contagem de mensagens
- Contagem de erros
Para ativar as análises no portal:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Configuration > Dev Portal > Application Settings no menu de administração do Drupal.
- Na página "Configurações do aplicativo", expanda a área Configurações de desempenho do app.
- Marque a caixa de seleção Mostrar a guia "Análise de aplicativos do desenvolvedor".
- Selecione Teste ou Produção para o Ambiente para consultar dados de análise. Para um portal disponível publicamente, normalmente você seleciona Produção.
- Salve a configuração.
Para exibir análises no portal de um app:
- Selecione o nome do app na página "Meus apps".
- Selecione o link Analytics do app.
- Selecione o tipo de análise a ser exibida e o período:
- As informações selecionadas são exibidas:
Aprovar ou revogar manualmente uma chave de API para um produto de API
Quando um desenvolvedor adiciona um produto de API a um app e o registra, o portal retorna ao desenvolvedor a chave de API desse app. O desenvolvedor usa essa chave para acessar os proxies de API agrupados pelo produto de API associado ao app.
Você controla o processo de aprovação de chaves para cada produto de API ao criar o produto:
O processo de aprovação pode ser:
- Automático: uma chave de API aprovada é retornada pelo portal para o produto de API quando o desenvolvedor registra o app. É possível revogar uma chave aprovada automaticamente.
- Manual: uma chave de API é retornada pelo portal quando o desenvolvedor registra o app, mas ela não é ativada para nenhum produto de API que usa aprovação manual de chave. Um administrador precisa aprovar manualmente a chave de API, na interface ou na API de gerenciamento do Edge, antes que ela possa ser usada pelo desenvolvedor para acessar o produto de API. Depois, é possível revogar uma chave aprovada manualmente.
Consulte Criar produtos de API para mais informações.
Se o portal permitir que um desenvolvedor adicione vários produtos de API a um app, ele poderá adicionar alguns produtos com aprovação automática de chave e outros com manual. O desenvolvedor pode usar a chave de API retornada para todos os produtos de API aprovados automaticamente imediatamente enquanto aguarda a aprovação final dos produtos que exigem aprovação manual.
Para ver a lista de produtos de API de um app e o status da aprovação da chave dele, um desenvolvedor seleciona o nome do app na página "Meus apps" e, em seguida, seleciona o link "Produtos":
Neste exemplo, o produto Premium Weather API usa a aprovação manual e está aguardando um administrador aprovar a chave. O produto de API sem custo financeiro usa aprovação automática, e o uso da chave para o acesso foi aprovado.
Para aprovar ou revogar uma chave manualmente:
- Faça login na interface de gerenciamento do Edge como usuário com privilégios de administração da sua organização.
- Selecione Plataforma de API na caixa suspensa no canto superior direito.
- Selecione Publicar > Apps do desenvolvedor para abrir a lista de apps do desenvolvedor.
- Selecione o botão Pendente para conferir a lista de apps com solicitações de chave
pendentes:
- Selecione o nome do app que você quer aprovar.
- Na página de detalhes do app, selecione o botão Editar no canto superior direito.
- Na lista de produtos de API do app, em Ações, faça o seguinte:
-
Para aprovar a chave, selecione o botão Aprovar de cada produto de API que precise de aprovação manual.
-
Para revogar uma chave aprovada, selecione o botão Revogar em "Ações para um produto de API para revogar o acesso".
-
Para aprovar a chave, selecione o botão Aprovar de cada produto de API que precise de aprovação manual.
- Salve o app. A chave de API foi aprovada.
Controlar o armazenamento em cache de produtos e apps de API
As informações sobre produtos de API e apps de desenvolvedores são armazenadas remotamente no portal da Apigee Edge. Isso significa que as alterações em produtos e apps de API podem ser realizadas na interface ou na API Edge sem passar pelo portal. Por exemplo, quando um administrador de back-end adiciona um novo produto de API, o portal não é atualizado imediatamente com essas informações.
Para garantir que o portal permaneça sincronizado com o back-end do Edge, é possível acionar manualmente uma atualização do cache do portal, atualizar os caches automaticamente quando o cron job do portal for executado ou ambos. Por exemplo, se você configurar o cron job para ser executado com frequência, a cada 5 ou 10 minutos, talvez não queira a sobrecarga de atualizar os produtos de API e os caches de app do desenvolvedor com tanta frequência. Nessa situação, você pode acionar a atualização do cache manualmente. No entanto, se o cron job for executado a cada uma ou duas horas, o tempo necessário para atualizar os caches pode não ter muito impacto.
Por padrão, o portal está configurado para recriar o produto de API e os caches do aplicativo do desenvolvedor sempre que o cron for executado.
Para especificar se o produto de API e os caches do aplicativo do desenvolvedor precisam ser recriados sempre que o cron é executado:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- No menu do Drupal, selecione Configuration > Dev Portal Settings > Application Settings.
- Marque ou desmarque a opção Rebuild API Product and Developer App cache sempre que o cron for executado.
- Salve as configurações.
Para atualizar os caches manualmente:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- No menu do Drupal, selecione o ícone Home > Limpar todos os caches.
Como personalizar os campos de formulário usados para registrar um app
Quando o desenvolvedor registra um app, o portal exibe o formulário padrão:
Como provedor de API, talvez você queira modificar esse formulário para solicitar mais informações, como um ID de cliente, a plataforma de destino do app ou outras informações. O portal permite adicionar novos campos ao formulário. Esses campos podem ser:
- Obrigatório ou opcional
- exibidos por diferentes elementos HTML, como caixas de texto, botões de opção, caixas de seleção e muito mais;
- Pode ser definido para aparecer em qualquer lugar do formulário entre os campos "URL de callback" e "Produto"
Para saber como personalizar o formulário de registro do app disponível no portal do desenvolvedor, assista este vídeo.
Por exemplo, o formulário a seguir mostra um campo obrigatório para o ID de cliente e um campo opcional para a plataforma de destino:
Quando você adiciona novos campos ao formulário, o upload dos valores deles é feito automaticamente para o Edge, junto com todos os outros campos, quando o desenvolvedor envia o formulário. Isso significa que você pode ver ou modificar esses campos no Edge ou usar a API Edge Management para acessar esses campos com um script.
Por exemplo, veja os novos campos de formulário na IU de gerenciamento de borda acessando Publicar > Apps do desenvolvedor e selecionando o nome do app. Os novos valores de campo aparecem na área "Custom Attributes" da página com um nome correspondente ao nome interno do campo:
Os valores dos campos também são exibidos na área "Detalhes" do app na página "Meus apps" do desenvolvedor:
O desenvolvedor também pode editar os valores selecionando o link "Editar" do app na página "Meus apps".
Os procedimentos abaixo descrevem como configurar os formulários de criação de apps usando a interface do administrador. Um desenvolvedor do Drupal pode realizar outras personalizações, incluindo modificar a página "Meus apps", usando hooks personalizados. Para saber mais sobre como mudar comportamentos usando códigos, consulte os exemplos de API do app no arquivo: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.
Para adicionar um campo ao formulário de registro do app, siga estas etapas:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Verifique se o módulo DevConnect App Attribute Management está ativado.
- Selecione Configuration > Dev Portal Settings > Dev Portal App Attributes no menu de administração do Drupal.
- Selecione o botão Add Dev Portal App Attribute na parte superior da página.
- Configure o campo. Por exemplo, no campo "ID de cliente" mostrado acima, use as seguintes configurações:
- Nome interno = cust_id. Esse é o nome da variável usada para armazenar o valor do campo.
- Nome público = ID de cliente
- Descrição = insira seu ID de cliente.
- Marque a caixa de seleção "Exigir este atributo".
- Marque a caixa de seleção para Exibir este atributo.
- Widget = caixa de texto
- Selecione "Salvar" para retornar à página "Atributos do app" do Portal do desenvolvedor.
- Selecione Salvar alterações.
- Selecione o ícone Home > Limpar todos os caches no menu Drupal.
Talvez seja necessário limpar o cache do navegador para que o novo campo apareça no formulário.
Para adicionar um campo opcional para que o desenvolvedor especifique a plataforma do app, defina os atributos do campo como:
- Nome interno = destination_platforms
- Nome público = Plataformas
- Descrição = especificar uma ou mais plataformas para seu app.
- Desmarque as caixas de seleção para Exigir este atributo.
- Marque a caixa de seleção para Exibir este atributo.
- Widget = lista de caixas de seleção
- Selecione "Salvar" para retornar à página "Atributos do app" do Portal do desenvolvedor.
Para reordenar os atributos no formulário:
- Faça login no portal como usuário com privilégios de administrador ou de criação de conteúdo.
- Selecione Configuration > Dev Portal Settings > Dev Portal App Attributes no menu de administração do Drupal.
- Selecione o símbolo de adição, +, na coluna "Nome" e arraste a propriedade para o local onde você quer que ela seja exibida no formulário.
- Salve as mudanças.