Como registrar aplicativos clientes

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Para participar dos fluxos do OAuth 2.0 na Apigee, os apps clientes precisam ser registrados.

O que é registro?

O registro permite que a Apigee (o servidor de autorização) identifique seu app de maneira exclusiva. Ao registrar seu aplicativo, você recebe duas chaves: um ID e uma chave secreta do cliente. O app precisa dessas chaves ao negociar tokens de acesso com o servidor de autorização.

Etapas rápidas

Para registrar um novo app, na página Apps:

Console do Apigee Cloud

  1. No console do Google Cloud , acesse a página Distribuição > Apps.

    Acessar "Apps".

  2. Clique em Criar.
  3. Especifique os Detalhes do app, conforme descrito na tabela a seguir:
    Campo Descrição Obrigatório?
    Nome do app Nome do app. Não é possível mudar o nome após a criação do app. Esse nome é usado nas chamadas para a API Apigee. Obrigatório
    Nome de exibição Nome de exibição do app que aparece na IU do Apigee e no portal do desenvolvedor. Opcional
    Desenvolvedor

    Selecione um nome de desenvolvedor na lista suspensa.

    Observação: por motivos de desempenho, nem todos os desenvolvedores são exibidos na lista suspensa. Comece a digitar o nome ou o e-mail do desenvolvedor na caixa de pesquisa, e os valores da lista suspensa serão automaticamente refinados para corresponder ao texto que você está digitando. Consulte também Registrar desenvolvedores de apps.

    		 Obrigatório
    URL de callback Normalmente especifica o URL de um aplicativo designado para receber um código de autorização em nome do aplicativo cliente. Esse valor não é obrigatório para todos os produtos de API. Opcional
    Observações Notas descritivas do aplicativo. Opcional
  4. Especifique as Credenciais, incluindo a expiração e o status da chave da API e os produtos da API associados. Na seção Credenciais, clique em Adicionar credencial e insira as seguintes informações:
    Campo Descrição
    Expiração Selecione uma duração ou data de validade ou defina a chave de API para nunca expirar.
    Produtos Associe um ou mais produtos da API à chave de API:
    1. Clique em Adicionar produtos.
    2. Selecione um ou mais produtos da API na lista.
    3. Clique em OK.
    4. Clique em Adicionar.
  5. Defina o Status como Aprovado ou Revogado para cada produto de API. Se você adicionou à credencial um produto de API que exige aprovação manual, ele vai mostrar Pending approval status. Caso contrário, ele vai mostrar Approved. Nesta etapa, você pode mudar o status de aprovação.
    1. Na lista de Produtos na seção Credenciais, selecione um ou mais produtos.
    2. Clique em Aprovar ou Revogar.
  6. Clique em Criar.
  7. Encontre seu novo aplicativo na lista de apps de desenvolvedores e selecione-o.
  8. Clique em para ver os valores de Chave (ID do cliente) e Chave secreta (chave secreta do cliente).

IU clássica

  1. Acesse a página "Aplicativos para desenvolvedores", conforme descrito abaixo.

    Para acessar a página "Apps do desenvolvedor", siga estas etapas:

    1. Abra a IU da Apigee.
    2. Selecione Publicar > Apps na barra de navegação à esquerda.
    3. Clique em + App.
    4. Preencha o formulário:
      1. Digite um nome e um nome de exibição para o app.
      2. Selecione um desenvolvedor (é possível escolher um dos desenvolvedores padrão ou criar o próprio).
      3. Opcional: insira um URL de callback. É usado para fluxos de tipo de concessão do OAuth de três etapas. É aqui que a Apigee redireciona o usuário depois que ele conclui a autenticação (login) com o servidor de recursos. Ele precisa ser um URL completo, por isso, insira algo como https://www.example.com. Para mais informações sobre o OAuth de três etapas, consulte Como implementar o tipo de concessão do código de autorização.
      4. Adicionar um produto de API. É possível selecionar um produto atual ou criar o próprio produto.
      5. Ignore a seção de atributos personalizados por enquanto.
      6. Clique em Criar.
    5. Encontre seu novo aplicativo na lista de apps de desenvolvedores e selecione-o.
    6. Clique em Mostrar para ver os valores de ID do cliente (ID do cliente) e do secret do cliente (chave secreta do cliente).

Mais informações

Para ver uma discussão mais detalhada sobre o registro de apps, consulte Registrar aplicativos e gerenciar chaves de API. Para saber mais sobre o papel dos produtos de API, consulte O que é um produto de API?.