Página de Registros de Aplicativos no Management Console Jitterbit
Introdução
A página Registros de aplicativos permite que os administradores da organização Harmony registrem aplicativos OAuth 2.0 (3LO) de externo para uso com determinados Integration Studio conectores. Depois que o aplicativo 3LO de externo for registrado na página App Registrations, você poderá autenticar uma conexão usando o OAuth 2.0 de 3 pernas.
Para obter mais informações sobre como autenticar uma conexão com 3LO, consulte Autenticação 3LO.
Nota
Se você estiver usando um aplicativo na nuvem (fornecido pelo Jitterbit), não será necessário registrar um aplicativo para configurar uma conexão.
Na página App Registrations, os administradores da organização podem registrar aplicativos privados com conectores habilitados para 3LO, definir os detalhes do provedor OAuth e definir o comportamento dos tokens de atualização. Para abri-lo, selecione Management Console > Customizations > App Registrations no menu do portal Harmony:
Você pode ver, criar, editar, ou apagar registros e visualizar e editar opções avançadas para um registro. Um conector pode ser registrado várias vezes. Cada um é considerado um aplicativo de conector exclusivo.
Visualizar
Sem registros, o corpo da página contém uma barra de ferramentas e uma tabela vazia:
Com os registros, o corpo da página contém uma barra de ferramentas e uma tabela listando os registros disponíveis:
-
Pesquisar: Insira o texto para encontrar entradas correspondentes.
-
Criar novo: Criar um novo registro.
-
Ações: Passe o mouse sobre uma linha para revelar os ícones de ações:
-
Opções avançadas: Mostrar opções avançadas para o registro.
-
Editar: Editar o registro.
-
Excluir: Excluir o registro.
-
Clique em qualquer cabeçalho de coluna (exceto Ações) para classificar a tabela em ordem crescente por essa coluna. Clique novamente para inverter a ordem de classificação.
Criar
Para criar um novo registro de aplicativo conector, siga estas etapas:
-
Clique em Criar novo. Uma nova linha aparece na tabela:
-
Defina valores para os seguintes campos:
Na seção Criar novo registro de aplicativo:
-
Nome: Um nome para o registro que é exclusivo para o conector.
-
Descrição: Uma descrição para o registro.
-
Conector: Clique para abrir o menu e selecione um dos conectores suportados. Atualmente, esses conectores suportam 3LO:
-
ID do cliente: O identificador do cliente atribuído pelo provedor OAuth.
-
Segredo do cliente: O segredo do cliente atribuído pelo provedor OAuth.
-
Escopo: Um ou mais espaços separados OAuth 2.0 scopes.
Na seção Configuração:
-
URL de autenticação: A URL para enviar uma solicitação de autorização.
-
URL do token de acesso: A URL para enviar uma solicitação de token de acesso.
-
URL do token de atualização: A URL para solicitar um novo token de acesso.
-
-
Clique Salvar para salvar os valores, ou Cancelar para cancelar:
-
Quando salvo com sucesso, o registro aparece como uma nova entrada na tabela:
Editar
Para editar um registro, siga estas etapas:
-
Passe o mouse sobre um registro na tabela para revelar os ícones de ações e clique em Editar. O painel Editar registro do aplicativo aparece:
-
No painel Editar registro do aplicativo, edite os campos e clique em Salvar para salvar as alterações ou Cancelar para cancelar.
Nota
O Connector de um registro não pode ser alterado de seu valor inicial.
-
Leia a mensagem de notificação que aparece na parte superior direita da janela. Para fechar a notificação, clique no botão ícone Fechar.
Excluir
Para excluir um registro, siga estas etapas:
-
Passe o mouse sobre um registro na tabela para revelar os ícones de ações e clique em Excluir.
-
Uma caixa de diálogo Excluir registro de aplicativo é aberta:
-
Insira o texto DELETE e clique em Delete ou clique em Cancel para cancelar a ação.
Opções avançadas
A gaveta Opções avançadas contém as configurações padrão fornecidas pelo provedor OAuth para cada token de registro e para as solicitações de autenticação, token e atualização.
Para abri-la, passe o mouse sobre um registro na tabela e clique em Opções avançadas. A gaveta aparece na parte inferior da página:
A gaveta contém estas abas:
Dica
Se uma aba tiver configurações inválidas, o botão Salvar ficará inativo e um símbolo de erro será exibido. aparece ao lado do rótulo da aba.
Política de token
A aba Política de token contém configurações para o token:
Importante
Habilite as configurações da aba Política de token somente se elas também estiverem habilitadas no provedor OAuth.
As seguintes configurações estão disponíveis:
-
Habilitar expiração do token de atualização: Clique para habilitar a expiração do token de atualização gerado nesta página. Quando usado em combinação com a configuração Receber notificação de expiração de uma conexão, o valor configurado no campo Dias para notificação de expiração correspondente da conexão é usado para notificá-lo sobre o número de dias configurado antes da expiração do token de atualização configurada aqui. Se habilitado, você será notificado, com um banner de aplicativo e email, quando os tokens estiverem prestes a expirar ou se já tiverem expirado. Ambas as formas de notificação informam o que fazer em cada caso.
Quando esta configuração está habilitada, a notificação por email é enviada aos administradores da organização Harmony (membros de uma papel com a permissão Admin e o usuário que implantou o projeto pela última vez.
Para definir o período de expiração, insira um número inteiro maior que zero, clique no menu e selecione um dos Segundos, Horas ou Dias:
Dica
A configuração recomendada para esse valor deve corresponder à usada no próprio provedor OAuth. Por exemplo, se a expiração do token de atualização de um provedor OAuth for de 1 ano, defina o valor Expirar após como 1 ano.
-
Habilitar expiração de inatividade do token de atualização: Clique para habilitar a expiração de inatividade do token. Para definir o período de expiração, insira um número inteiro maior que zero, clique no menu e selecione um dos Segundos, Horas ou Dias:
Dica
A configuração recomendada para esse valor deve corresponder à usada no próprio provedor OAuth. Por exemplo, se a expiração de inatividade do token de atualização de um provedor OAuth for de 90 dias, defina o valor Expirar após para 90 dias.
-
Habilitar token de atualização rotativo: Clique para habilitar a rotação do token:
Clique em Salvar para salvar as alterações ou em Cancelar para abandoná-las.
Solicitação de autenticação
A aba Solicitação de autenticação contém configurações para a solicitação de autenticação de token:
-
URL de autenticação: A URL para enviar uma solicitação de autorização.
-
Parâmetros: Para adicionar parâmetros para a solicitação, siga estas etapas:
-
Insira valores para Chave e Valor.
-
Para escolher o método de envio de parâmetros, clique no menu Enviar e selecione Solicitar URL ou Solicitar Cabeçalho.
-
Clique Adicionar. O parâmetro aparece como uma nova linha na tabela.
-
Repita as três etapas anteriores para todos os parâmetros.
-
Clique em Salvar para salvar as alterações ou em Cancelar para abandoná-las.
Pedido de token
A aba Solicitação de token contém configurações para a solicitação de token:
-
URL do token de acesso: A URL para enviar uma solicitação de token de acesso.
-
Parâmetros: Para adicionar parâmetros para a solicitação, siga estas etapas:
-
Insira valores para Chave e Valor.
-
Para escolher o método de envio de parâmetros, clique no menu Enviar e selecione URL da solicitação, Cabeçalho da solicitação ou Corpo da solicitação.
-
Clique Adicionar. O parâmetro aparece como uma nova linha na tabela.
-
Repita as três etapas anteriores para todos os parâmetros.
-
Clique em Salvar para salvar as alterações ou em Cancelar para abandoná-las.
Solicitação de atualização
A aba Solicitação de atualização contém configurações para a solicitação de atualização do token:
-
URL do token de atualização: A URL para solicitar um novo token de acesso.
-
Parâmetros: Para adicionar parâmetros para a solicitação, siga estas etapas:
-
Insira valores para Chave e Valor.
-
Para escolher o método de envio de parâmetros, clique no menu Enviar e selecione URL da solicitação, Cabeçalho da solicitação ou Corpo da solicitação.
-
Clique Adicionar. O parâmetro aparece como uma nova linha na tabela.
-
Repita as três etapas anteriores para todos os parâmetros.
-
Clique em Salvar para salvar as alterações ou em Cancelar para abandoná-las.