Registar programadores de apps

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Registe e faça a gestão dos programadores de apps, conforme descrito nas secções seguintes. (O registo de apps é um processo separado, conforme descrito no artigo Controle o acesso às suas APIs registando apps).

Introdução

O Apigee oferece muitas vantagens que dependem totalmente de saber quem está a chamar as suas APIs. Por exemplo, a segurança da API, a gestão do tráfego e uma quantidade razoável de dados de estatísticas dependem de saber quem está a fazer a chamada. E como é que o Apigee sabe quem está a chamar as suas APIs? Através da leitura de informações únicas em cada chamada API, como um ID do utilizador, uma chave API ou um token OAuth. Essas informações exclusivas bloqueiam ou desbloqueiam a funcionalidade que cria nos seus proxies de API, dando-lhe controlo total sobre o acesso e o comportamento da API.

É por isso que os programadores de apps têm de se registar para usar as suas APIs. Depois de adicionadas, os programadores registam as respetivas apps, escolhem as APIs que querem usar e recebem as credenciais da API únicas (chaves e segredos do consumidor) necessárias para aceder às suas APIs.

Aviso: a segurança da API, a gestão do tráfego e as estatísticas de programadores/apps dependem da configuração adequada do proxy da API. Por exemplo, tem de adicionar as políticas certas aos seus proxies, como a validação da chave de API ou a verificação do token de acesso OAuth, a aplicação de quotas e a limitação de taxas. Essas políticas identificam o programador e a app específicos que estão a fazer a chamada, o que, por sua vez, permite a aplicação da segurança da API, a gestão do tráfego específica do programador ou da app, a captura de estatísticas da API e outras funcionalidades. Tecnicamente, pode desenvolver APIs abertas que não verifiquem a existência de chaves da API nem tokens de acesso, o que significa que não precisa de registar programadores. No entanto, desaconselhamos vivamente esta ação, uma vez que perde a segurança da API, o controlo sobre o desempenho (através de uma boa gestão do tráfego), os dados de estatísticas e outros benefícios importantes que o Apigee oferece.

Como registar programadores de apps

Registe programadores de apps através de um dos seguintes métodos:

• Se tiver uma conta do Apigee paga, os programadores podem registar-se autonomamente através de um portal do programador. Para mais informações, consulte uma das seguintes secções com base no tipo de portal para programadores:
  • Portal integrado: criar uma conta de utilizador no portal integrado
  • Drupal 10: registe um programador de apps
• Os administradores podem registar programadores de apps através da API.
• Como administrador do portal do programador, pode gerir os programadores diretamente no seu portal, conforme descrito nas secções seguintes:
  • Portal integrado: gestão de utilizadores para gerir contas de utilizador.
    Nota: depois de um utilizador criar uma app no portal integrado, conforme descrito nesta secção, as informações da conta de utilizador são sincronizadas e ficam disponíveis no Apigee na página Developers. O registo do programador de apps está associado à conta do utilizador através do respetivo endereço de email. Para mais informações sobre onde as informações da conta e da app associada são armazenadas, consulte o artigo Onde são armazenadas as informações da conta de programador de apps.
  • Drupal 10: compreenda como os programadores de apps interagem com o módulo Apigee
• Como administrador da organização, faça a gestão dos programadores através da IU ou da API do Apigee, conforme descrito nas secções seguintes.

Nota: quando os utilizadores do portal criam uma equipa no portal integrado, as informações da equipa de programadores são armazenadas no Apigee e é gerado um endereço de email único gerado automaticamente para servir como a chave principal usada pelo Apigee para identificar a equipa de programadores. Para mais informações, consulte o artigo Onde as informações da equipa de programadores são armazenadas (beta).

Recomendações para gerir contas de utilizador em portais de programadores

A Apigee recomenda que faça a gestão das contas de utilizador diretamente no seu portal do programador.

Se estiver a usar o portal integrado, esta é a única forma de garantir que as contas de utilizador no portal integrado e no Apigee permanecem sincronizadas.

Se usar o portal do programador baseado no Drupal, a gestão das contas de utilizador diretamente no portal do programador oferece as seguintes vantagens:

• Quando adiciona um programador através da interface de administrador no portal, pode definir a palavra-passe do programador para o portal e acionar uma mensagem de email automática enviada ao programador.

  Quando adiciona ou modifica um programador através do Apigee, não é enviado nenhum email ao programador e não pode definir a palavra-passe do programador no portal. Por conseguinte, o programador tem de repor a palavra-passe no portal antes de poder iniciar sessão no mesmo.

• Todas as alterações feitas à conta do programador no portal são enviadas automaticamente para o Apigee.

Se decidir gerir contas de utilizadores baseadas no Drupal através do Apigee, tem de sincronizar os programadores de apps entre o portal e o Apigee.

Explorar a página de programadores

Aceda e explore a página Developers através da IU do Apigee.

Nota: para portais integrados, as contas de utilizador são geridas conforme descrito no artigo Gerir utilizadores. Depois de um programador criar uma app no portal integrado, conforme descrito em Registar apps, é criado um registo de programador separado para monitorizar as apps associadas à conta de utilizador e que pode ser acedido na página Programadores. O registo de programador está associado através do endereço de email do utilizador.

Para aceder à página Distribuição > Programadores:

Aceda ao Google Developers

A página Programadores permite-lhe:

• Adicione um programador
• Veja e edite os detalhes do programador, incluindo o seguinte:
• Faça a gestão de atributos personalizados
• Ative ou desative um programador
• Exporte dados de publicação
• Elimine um programador
• Pesquise a lista de programadores

Adicionar um programador

Para adicionar um programador:

1. Aceda à página Programadores.
2. Clique em + Criar.
3. Introduza os detalhes do programador, incluindo o nome próprio, o apelido, o email e o nome de utilizador.
4. Clique em Adicionar.

Consulte também o artigo Gerir utilizadores.

Visualizar e editar detalhes do programador

Veja e edite os detalhes do programador.

Para ver e editar os detalhes do programador:

1. Aceda à página Programadores.
2. Clique na linha do programador que quer ver e editar para abrir os detalhes do programador.
3. Na secção Detalhes, são apresentadas as seguintes informações. Clique em Editar para editar os detalhes do programador, conforme necessário.

   Detalhe	Descrição
   Detalhes	Nome próprio e apelido, nome de utilizador e email do programador; estado e duração do registo; e ID do programador.
   Atributos personalizados	Atributos personalizados definidos para o programador. Configure atributos personalizados, conforme necessário. Para mais informações, consulte o artigo: Faça a gestão de atributos personalizados para um programador
   Apps	Apps que foram registadas pelo programador. Consulte o artigo Controlar o acesso às suas APIs através do registo de apps.

4. Ative ou desative o programador no campo Estado.
   Para mais informações, consulte o artigo Ativar e desativar um programador.

O Apigee mantém as seguintes entidades na cache durante um mínimo de 180 segundos após o acesso às entidades.

• Tokens de acesso OAuth. Isto significa que o elemento ExpiresIn na política OAuth v2 não vai poder fazer expirar uma chave de acesso em menos de 180 segundos.
• Entidades do Key Management Service (KMS) (Apps, Developers e API Products).
• Atributos personalizados em tokens OAuth e entidades KMS.

Gerir atributos personalizados para um programador

Adicione até 18 atributos personalizados para cada programador.

Para gerir atributos personalizados:

1. Aceda à página Programadores.
2. Clique na linha do programador para o qual quer gerir atributos personalizados para abrir os detalhes do programador.
3. Clique em Editar.
4. Clique em + Adicionar atributo na secção Atributos personalizados.
5. Introduza o nome e o valor do atributo.
6. Clique em Guardar.
7. Para eliminar um atributo personalizado, clique em Editar, depois Eliminar e, de seguida, clique em Guardar.

Ativar e desativar um programador

Quando um programador de apps se regista autonomamente no seu portal, pode configurar se está ativo por predefinição.

Quando um programador está inativo, continua a poder iniciar sessão no portal do programador e criar apps, mas nenhuma das chaves da API correspondentes funciona. As apps do programador mantêm o respetivo estado aprovado (ou outro), tal como as chaves de API, mesmo que não sejam válidas enquanto o programador estiver inativo.

Nota: quando desativa um programador, a alteração pode demorar alguns minutos a ser atualizada em todos os processadores de mensagens. Até lá, algumas chamadas da app do programador podem ter êxito.

Para ativar ou desativar um programador:

1. Aceda à página Programadores.
2. Clique na linha do programador que quer ativar ou desativar para abrir os detalhes do programador.
3. Clique em Editar.
4. Na secção Detalhes, defina o campo Estado como Ativo ou Inativo, conforme necessário.
5. Clique em Guardar.
6. Repita os passos se o programador estiver em várias organizações.

Exportar dados de publicação

Esta secção descreve como exportar dados de publicação para programadores, apps ou produtos de API como um ficheiro de valores separados por vírgulas (CSV) ou um ficheiro JSON.

Pré-requisitos:

• Contentor do Cloud Storage
• Acesso de leitura aos dados que está a exportar
• Acesso de leitura e escrita ao contentor do Cloud Storage

Para mais informações sobre contentores, consulte o seguinte:

• Acerca dos contentores do Cloud Storage
• Crie um contentor
• Listar contentores

Para exportar dados de publicação:

1. Crie o contentor do Cloud Storage ou obtenha o nome de um contentor existente.
2. Aceda a uma das seguintes páginas:

   • Na Google Cloud consola, aceda à página Distribuição > Programadores.

     Aceda ao Google Developers

   • Na Google Cloud consola, aceda à página Distribuição > Apps.

     Aceda a Apps

   • Na Google Cloud consola, aceda à página Distribuição > Produtos API.

     Aceda a Produtos

3. Clique em Exportar.
4. É apresentada a caixa de diálogo Guardar tabela como. Escreva o nome do contentor do Cloud Storage e especifique o formato de exportação: JSON ou CSV.
5. Clique em Guardar. É iniciada uma operação de longa duração (LRO). O estado da LRO é apresentado no ícone Notificação.
6. Quando a exportação estiver concluída, clique em Transferir na notificação. É aberta a página do contentor do Cloud Storage para o ficheiro.
7. Clique em Transferir. O ficheiro é transferido para a sua máquina local.

Notas sobre os dados exportados:

• A estrutura dos dados exportados segue exatamente as definições do protocolo, pelo que a documentação do protocolo pode ser usada como referência para as estruturas dos dados exportados. Veja:
  • Programadores
  • Apps
  • API Products
• Ao contrário da IU do Apigee Classic, cada recurso tem um botão de exportação independente e dedicado.
• As exportações CSV não listam campos repetidos ou aninhados do proto, uma vez que não podem ser representados corretamente numa estrutura de dados de tabela. Para obter estas informações, tem de usar a exportação JSON.
• Os ficheiros exportados têm o nome ExportFinal_{hash}.

Eliminar um programador

Aviso: a eliminação de programadores remove-os completamente, bem como os respetivos artefactos relacionados (como apps e chaves de API) da sua organização. Para evitar a eliminação permanente dos programadores e dos respetivos artefactos, considere desativar os programadores.

Para eliminar um programador:

1. Aceda à página Programadores.
2. Posicione o cursor sobre a linha do programador que quer eliminar.
3. Clique em Mais e, de seguida, clique em Eliminar.
4. Clique em Eliminar para confirmar a eliminação.

Sincronizar programadores de apps entre o portal e o Apigee

Se estiver a usar um portal do programador baseado no Drupal para publicar as suas APIs, as alterações feitas aos programadores de apps através do Apigee não são propagadas para o portal. Tem de iniciar sessão no portal como administrador do portal e sincronizar o portal com o Apigee para que essas alterações apareçam no portal.

Nota: se usar o portal do programador baseado no Drupal, a Apigee recomenda que faça a gestão dos programadores de apps diretamente no seu portal e não através do Apigee. Consulte as recomendações para gerir contas de utilizador em portais de programadores

.

Para sincronizar o portal do programador com os programadores de apps definidos no Apigee, consulte a secção seguinte:

Drupal 10: sincronize programadores com o Apigee

Gerir programadores através da API

Faça a gestão dos programadores através das APIs Developer.