Você está visualizando a documentação do Apigee Edge.
Acesse a
documentação da
Apigee X. info
Para registrar um novo app, o desenvolvedor seleciona o botão "Adicionar um novo app" na página "Meus apps".
Em seguida, o portal mostra 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 que serão adicionados ao app.
Como provedor de API, você tem controle total sobre o processo de registro de apps. 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 manualmente ou automaticamente para um produto de API
- Se outras informações são necessárias na página "Adicionar app" para registrar o app
Neste tópico, descrevemos como configurar o processo de registro de apps no 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 impedir que os desenvolvedores criem, excluam ou editem apps com base no papel atribuído a eles. Por exemplo, você pode configurar o portal para criar um único app padrão para todos os desenvolvedores quando eles se registrarem. Em seguida, você só permite que alguns desenvolvedores adicionem novos apps, possivelmente com base em uma estrutura de taxas ou outras características do desenvolvedor. Use funções e permissões para controlar quais desenvolvedores podem criar, excluir e editar apps. Consulte Adicionar e gerenciar contas de usuário para saber mais.
Como especificar os produtos de API disponíveis no portal
Há duas maneiras de especificar os produtos de API que estão 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 funções
Como especificar o nível de acesso ao criar um produto de API
Ao criar um produto de API, você especifica a opção de nível de acesso do produto, conforme 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 da API com base em papéis
Ao ativar o módulo de acesso a papéis de produtos de API do Drupal, você pode especificar os papéis que podem acessar cada produto de API.
Para restringir o acesso a um produto de API com base nos papéis do desenvolvedor:
- Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
- Revise as funções do portal de desenvolvedor e as atribuições do usuário:
- Selecione Pessoas > Permissões > Funções no menu de administração do Drupal e adicione ou edite as funções e permissões do desenvolvedor, conforme necessário.
- Selecione Pessoas no menu de administração do Drupal e edite as atribuições de usuário e função, conforme necessário.
- Selecione Configuration > Dev Portal > API Product Role Access no menu de administração do Drupal.
- Selecione os papéis que vão ter acesso a cada produto de API.
- Clique em Save configuration.
Como configurar a associação de 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 de adição de apps:
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. Ou você pode especificar um produto padrão atribuído a todos os apps.
As seguintes opções de configuração estão disponíveis no portal para controlar a seleção de produtos de API ao registrar um app:
- Não associe apps a nenhum produto de API.
- Associe todos os apps a um ou mais produtos de API padrão (configurados abaixo). Os desenvolvedores não podem adicionar outros produtos de API ao app.
- Permita a seleção de um único produto de API, mas não exija isso.
- Exija a seleção de um único produto de API.
- Permitir a seleção de vários produtos de API, mas não exigir nenhum.
- Permita a seleção de vários produtos de API e exija pelo menos um.
Também é possível controlar o elemento HTML que aparece no formulário que o desenvolvedor usa 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 único produto de API.
Para definir a opção de seleção de produtos de API:
- Faça login no portal como um 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 da API.
- Em Processamento de produtos de API, selecione a opção que controla a seleção de produtos de API.
- Se você especificar a opção "Associar todos os apps a um ou mais produtos de API padrão (configurado 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.
Como configurar o processamento de URLs de callback
Se um proxy de API no seu produto de API usa o "OAuth de três pernas" (tipo de concessão de código de autorização), os desenvolvedores precisam 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 a 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 mais informações, consulte Como implementar o tipo de concessão do código de autorização.
Para controlar o URL de callback para a seleção de produtos de API:
- Faça login no portal como um 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 Processamento do URL de chamada de retorno, selecione uma das seguintes opções.
- O URL de callback é obrigatório para todos os apps de desenvolvedor.
- O URL de callback é opcional para todos os apps de desenvolvedor.
- O URL de callback não é obrigatório nem exibido.
- Salve a configuração.
Mostrar análises de uso do app
O portal pode mostrar informações analíticas sobre o uso do app. Se a exibição de análises estiver ativada, os desenvolvedores poderão acessar as análises na página "Meus apps" de cada app. Por exemplo, um desenvolvedor pode mostrar as seguintes análises de um app:
- Capacidade
- Tempo de resposta máximo
- Tempo de resposta mínimo
- Contagem de mensagens
- Contagem de erros
Para ativar a análise no portal:
- Faça login no portal como um 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", abra a área Configurações de desempenho do app.
- Marque a caixa de seleção Mostrar guia "Analytics for Developer App".
- Selecione Teste ou Produção para Ambiente para consultar dados de análise. Para um portal disponível publicamente, normalmente você seleciona Produção.
- Salve a configuração.
Para mostrar análises no portal de um app:
- Selecione o nome do app na página "Minhas apps".
- Selecione o link Google Analytics do app.
- Selecione o tipo de análise a ser mostrado e o período:
- As informações selecionadas aparecem:
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 a chave de API para o desenvolvedor. O desenvolvedor usa essa chave para acessar os proxies de API agrupados pelo produto associado ao app.
Você controla o processo de aprovação de chaves para cada produto de API ao criá-lo:
O processo de aprovação pode ser:
- Automático: uma chave de API aprovada é retornada pelo portal do produto de API quando o desenvolvedor registra o app. É possível revogar uma chave aprovada automaticamente mais tarde.
- Manual: uma chave de API é retornada pelo portal quando o desenvolvedor registra o app, mas a chave não é ativada para produtos de API que usam a aprovação manual. Um administrador precisa aprovar manualmente a chave de API, na API ou na IU de gerenciamento do Edge, antes que ela possa ser usada pelo desenvolvedor para acessar o produto de API. É possível revogar uma chave aprovada manualmente mais tarde.
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 e outros com aprovação 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 para os produtos que exigem aprovação manual.
Para conferir a lista de produtos de API de um app e o status da aprovação da chave para o produto de API, o desenvolvedor seleciona o nome do app na página "Meus apps" e, em seguida, o link "Produtos":
Neste exemplo, o produto da API Premium Weather usa a aprovação manual e está aguardando um administrador aprovar a chave. O produto de API sem custo financeiro usa a aprovação automática, e o uso da chave para acessar foi aprovado.
Para aprovar ou revogar uma chave manualmente:
- Faça login na interface de gerenciamento do Edge como um usuário com privilégios de administração da sua organização.
- Selecione Plataforma da API no menu suspenso no canto superior direito.
- Selecione Publicar > Apps do desenvolvedor para abrir a lista de apps de desenvolvedor.
- Selecione o botão Pendente para ver 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:
-
Para aprovar a chave, selecione o botão Aprovar para cada
produto de API que exige aprovação manual.
-
Para revogar uma chave aprovada, selecione o botão Revogar
em "Ações" para um produto de API e revogue o acesso.
-
Para aprovar a chave, selecione o botão Aprovar para cada
produto de API que exige aprovação manual.
- Salve o app. A chave de API foi aprovada.
Como controlar o armazenamento em cache de produtos de API e apps
As informações sobre produtos de API e apps de desenvolvedor são armazenadas remotamente no portal da Apigee Edge. Isso significa que as mudanças em produtos e apps de API podem ser realizadas na interface ou na API do 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, você pode acionar manualmente uma atualização do cache do portal, atualizar os caches automaticamente quando o job cron do portal for executado ou ambos. Por exemplo, se você configurar o cron job para ser executado com frequência, como a cada 5 ou 10 minutos, talvez não queira a sobrecarga de atualizar os produtos da API e os caches do app do desenvolvedor com tanta frequência. Nesse caso, é possível acionar a atualização do cache manualmente. No entanto, se o job do cron for executado a cada hora ou duas, o tempo necessário para atualizar os caches pode não ter muito impacto.
Por padrão, o portal é configurado para recriar os caches do produto de API e do app do desenvolvedor sempre que o cron é executado.
Para especificar se o produto da API e os caches do app do desenvolvedor serão reconstruídos sempre que o cron for executado:
- Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
- No menu do Drupal, selecione Configuração > Configurações do portal do desenvolvedor > Configurações do aplicativo.
- Marque ou desmarque a opção Recriar os caches do produto da API e do app do desenvolvedor sempre que o cron for executado.
- Salve as configurações.
Para atualizar os caches manualmente:
- Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
- No menu do Drupal, selecione o ícone de início > Limpar todos os caches.
Personalizar os campos do formulário usados para registrar um app
Quando o desenvolvedor registra um app, o portal mostra o formulário padrão:
Como provedor de API, você pode modificar esse formulário para solicitar que o desenvolvedor forneça outras informações, como um ID de cliente, a plataforma de destino do app ou outras informações. O portal permite adicionar novos campos a esse formulário. Esses campos podem ser:
- Obrigatório ou opcional
- Exibida 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 o campo "URL de callback" e o campo de produto
Para saber como personalizar o formulário de registro de apps 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 do cliente e um campo opcional para a plataforma de destino:
Quando você adiciona novos campos ao formulário, os valores são enviados automaticamente para o Edge, junto com todos os outros campos, quando o desenvolvedor envia o formulário. Isso significa que você pode visualizar ou modificar esses campos no Edge ou usar a API de gerenciamento do Edge para acessar esses campos em um script.
Por exemplo, para conferir os novos campos de formulário na interface de gerenciamento do Edge, acesse Publicar > Apps para desenvolvedores e selecione o nome do app. Os novos valores de campo aparecem na área de atributos personalizados da página com um nome que corresponde ao nome interno do campo:
Os valores do campo 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 "Minhas apps".
Os procedimentos abaixo descrevem como configurar os formulários de criação de apps usando a interface de administrador. Um desenvolvedor do Drupal pode realizar outras personalizações, incluindo a modificação da página "Minhas apps", usando hooks personalizados. Para saber mais sobre como mudar comportamentos pelo código, 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:
- Faça login no portal como um usuário com privilégios de administrador ou de criação de conteúdo.
- Verifique se o módulo Gerenciamento de atributos do app do DevConnect 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 de cima da página.
- Configure o campo. Por exemplo, para o campo "ID do cliente" mostrado acima, use as seguintes configurações:
- Internal Name = cust_id. Esse é o nome da variável usada para armazenar o valor do campo.
- Nome público = ID do cliente
- Description: insira seu ID de cliente.
- Marque a caixa de seleção "Exigir este atributo".
- Marque a caixa de seleção "Mostrar este atributo".
- Widget = caixa de texto
- Selecione "Salvar" para voltar à página "Atributos do app do portal do desenvolvedor".
- Selecione Salvar alterações.
- Selecione o ícone de início > Limpar todos os caches no menu do 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:
- Internal Name = intended_platforms
- Nome público = plataformas
- Descrição: especifique uma ou mais plataformas para o app.
- Desmarque as caixas de seleção em "Requer este atributo".
- Marque a caixa de seleção "Mostrar este atributo".
- Widget = lista de caixas de seleção
- Selecione "Salvar" para voltar à página "Atributos do app do portal do desenvolvedor".
Para reordenar os atributos no formulário:
- Faça login no portal como um 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 em que você quer que ela apareça no formulário.
- Salve as alterações.