Como integrar o ADManager Plus e o Employment Hero

Pré-requisitos:

O Employment Hero usa o OAuth2.0 para autorizar solicitações de API. Você precisará ter o client_id e o client_secret para recuperar as informações desejadas e executar tarefas no Employment Hero. Consulte a documentação de API do Employment Hero para obter mais detalhes.

Privilégios:

Para importar usuários do Employment Hero (ação de entrada): Certifique-se de que a conta usada para autorização tenha permissão para ler todas as contas de usuário.

Para executar qualquer ação ou consulta no Employment Hero (ação de saída): Certifique-se de que a conta usada para autorização tenha permissão para executar a ação desejada.

Configuração de autorização

• Efetue login no ADManager Plus e navegue até a aba Automation.
• No painel esquerdo, em Configuration, clique em Application Integrations.
• Em Enterprise Applications, clique em Employment Hero.
• Ative o botão Enable Employment Hero Integration.
• Na página Employment Hero Configuration, clique em Authorization.
• Insira os valores de client_id e client_secret gerados no Employment Hero nos respectivos fields.
• Clique em Configure.

Configuração do webhook de entrada

Os webhooks de entrada permitem buscar dados de usuário do Employment Hero e enviá-los para o ADManager Plus. O mapeamento de atributos configurado nesta seção pode ser selecionado como a fonte de dados durante a configuração da automação para executar a ação desejada na lista de usuários recebida da resposta da API. Para configurar um webhook de entrada para o Employment Hero:

• Em Inbound Webhook, clique em Employment Hero Endpoint Configuration.

• Na aba Endpoint Configuration, um endpoint, Employment Hero USERS ENDPOINT, vem pré-configurado com campos Endpoint URL, API Method, Headers e Parameters para buscar contas de usuários do Employment Hero. No entanto, se desejar usar um novo endpoint para importar usuários, você pode configurar um usando o + Add API endpoint button e preenchendo os campos necessários de acordo com a documentação de API do Employment Hero. Clique aqui para saber como.

  Observação:

  • O par de valores de chave de API é pré-configurado como um cabeçalho para autenticar solicitações de API, conforme configurado durante a authorization configuration.
  • Macros: Você pode adicionar macros à configuração de seu endpoint para mudá-lo dinamicamente conforme seus requisitos usando o componente macro chooser.
  • Consulte a documentação de API do Employment Hero e configure cabeçalhos e parâmetros adicionais, se necessário.

• Quando terminar, clique em Test & Save. Uma janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos usando a chamada de API. Clique em Proceed.

  Observação:

  • Consulte a documentação de API do Employment Hero para saber mais sobre os parâmetros que devem ser configurados para buscar apenas parâmetros específicos.
  • Você pode configurar vários endpoints para o Employment Hero usando o + Add API endpoint button. Clique aqui para saber como.
• Clique em Data Source - LDAP Attribute Mapping para corresponder endpoints e mapear os atributos LDAP do AD com os respectivos atributos no Employment Hero.

  [O ADManager Plus também permite que você personalize o formato do atributo do Employment Hero.]

• Clique em + Add New Configuration e faça o seguinte:

  • Digite o Configuration Name e a Description e selecione a Automation Category no menu suspenso.

  • No campo Select Endpoint, selecione o endpoint desejado e uma Primary Key que seja exclusiva de um usuário (por exemplo, employeeIdentifier).

    Observação: Quando vários endpoints são configurados, esse atributo deve ter o mesmo valor em todos os endpoints.
  • No campo Attribute Mapping, selecione o atributo no menu suspenso LDAP Attribute Name e mapeie-o com a respectiva coluna no Employment Hero.
  • Se você quiser criar um novo formato personalizado para isso, clique em Mapping Attribute.
• Clique em Save.

Configuração do webhook de saída

Os webhooks de saída permitem atualizar as mudanças feitas no AD enviando as informações do ADManager Plus para o Employment Hero ou buscar ou encaminhar os detalhes necessários do Employment Hero e sincronizá-los com o AD. Para configurar um webhook de saída para o Employment Hero:

• Em Outbound Webhook, clique em Employment Hero Webhook Configuration.
• Clique em + Add Webhook.
• Digite um nome e uma descrição para esse webhook.
• Decida a ação que deve ser executada e consulte a documentação de API do Employment Hero para obter os detalhes da API, como URL, cabeçalhos e parâmetros.
• Selecione o método HTTP que permitirá que você execute a ação desejada no endpoint no menu suspenso.
• Digite o URL do endpoint.
• Configure Headers, Parameters e Message Type no formato apropriado com base na chamada de API que você gostaria de executar.
• Clique em Test and Save.
• Uma janela pop-up exibirá uma lista de usuários e grupos do AD para testar a chamada de API configurada. Selecione o usuário ou grupo desejado sobre o qual essa solicitação de API deve ser testada e clique em OK. Isso fará uma chamada em tempo real para o URL do endpoint e os objetos selecionados serão modificados de acordo com a configuração.
• A resposta do webhook e os detalhes da solicitação serão exibidos. Verifique se eles correspondem ao comportamento esperado da API e clique em Save.