Como integrar o ADManager Plus e o BreezyHR

Pré-requisitos:

• O BreezyHR usa OAuth 2.0 para autorizar solicitações de API.
• Ele requer um client_id e um client_secret para autorização.

Privilégios:

• Para importar usuários (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 realizar qualquer ação ou consulta no BreezyHR (ação de saída): Certifique-se de que a conta usada para autorização tenha permissão para realizar a ação desejada.

Configuração de autorização

• Faça login no ADManager Plus e navegue até a guia Automação.
• No painel esquerdo, em Configuração, clique em Integrações de aplicações.
• Em Aplicações corporativas, clique em BreezyHR.
• Ative o botão Ativar integração com o BreezyHR.
• Na página Configuração do BreezyHR, clique em Autorização.
• Execute as etapas para gerar um client_id(ID de cliente) e um client_secret (Senha de cliente) do BreezyHR e cole-os nos respectivos campos de valor.
• Clique em Definir.

Configuração de webhook de entrada

Webhooks de entrada permitem que você busque dados do usuário do BreezyHR e os envie para o ADManager Plus. O mapeamento de atributos configurado nesta seção pode ser selecionado como fonte de dados durante a configuração da automação. Para configurar um webhook de entrada para o BreezyHR:

• Em Webhook de entrada, clique em Configuração de endpoint do BreezyHR.
• Na guia Configuração de endpoint, um ENDPOINT DE USUÁRIOS do BreezyHR vem pré-configurado com campos de URL de endpoint, Método da API, Cabeçalhos e Parâmetros para buscar contas de usuário no BreezyHR. Se desejar utilizar esse endpoint pré-configurado, substitua {subdomain} pelo nome de domínio da sua instância do BreezyHR no campo URL do endpoint. No entanto, se você quiser usar um novo endpoint para importar usuários, é possível configurar um usando o botão + Adicionar endpoint de API e preenchendo os campos obrigatórios de acordo com a documentação da API do BreezyHR. Clique aqui para saber como.

  Nota:

  • O par de valores de chave da API é pré-configurado como um cabeçalho para autenticar solicitações de API conforme definido durante a configuração da autorização.
  • Macros: Você pode adicionar macros à sua configuração de endpoint para alterá-la dinamicamente de acordo com sua necessidade usando o componente de seleção de macros.
  • Consulte a documentação da API do BreezyHR e configure cabeçalhos e parâmetros adicionais, se necessário. Na guia Configurações, a opção Repetir chamada para este endpoint será configurada para buscar 30 registros por chamada. Isso será repetido até que nenhum token da próxima página seja recebido.
• Ao terminar, clique em Testar e Salvar. Uma janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos usando a chamada da API. Depois de verificar se os parâmetros solicitados foram acionados, clique em Prosseguir.

  Nota:

  • Consulte a documentação da API do BreezyHR para aprender sobre os parâmetros que devem ser configurados para buscar somente parâmetros específicos.
  • Você pode configurar múltiplos endpoints para o BreezyHR usando o botão + Adicionar endpoint da API. Clique aqui para saber como.
• Clique em Fonte de dados - Mapeamento de atributos de LDAP para combinar os endpoints e mapear os atributos de LDAP do AD com os respectivos atributos no BreezyHR.
• Clique em + Adicionar nova configuração e execute as seguintes ações:
  • Insira o Nome e a Descrição da configuração e selecione a Categoria de automação no menu suspenso.
  • No campo Selecionar endpoint, selecione o endpoint desejado e uma Chave primária que seja exclusiva a um usuário (por exemplo, employeeIdentifier).

    Nota: Quando vários endpoints são configurados, esse atributo deve conter o mesmo valor em todos eles.

  • No campo Mapeamento de Atributos, selecione o atributo no menu suspenso Nome do atributo de LDAP e mapeie-o com a respectiva coluna no BreezyHR.
  • Se desejar criar um novo formato personalizado para ele, clique em Adicionar novo formato.
  • Clique em Salvar.

Configuração de webhook de saída

Os webhooks de saída permitem que você envie as mudanças feitas no AD para o BreezyHR, buscar dados do BreezyHR e realizar tarefas nele, tudo a partir do ADManager Plus. Os webhooks configurados nesta seção podem ser incluídos nos Templates de orquestração, que, por sua vez, podem ser usados durante automações programadas e orientadas por eventos. Eles também podem ser aplicados diretamente nos usuários desejados para realizar uma sequência de ações neles (Gerenciamento > Gerenciamento avançado > Orquestração). Para configurar webhooks de saída para o BreezyHR:

• Em Webhook de saída, clique em Configuração de webhook do BreezyHR.
• Clique em + Adicionar webhook.
• Insira um nome e uma descrição para esse webhook.
• Decida a ação a ser executada e consulte a documentação da API do BreezyHR para obter os detalhes da API, como URL, cabeçalhos e parâmetros.
• No menu suspenso, selecione o método HTTP que permitirá que você execute a ação desejada no endpoint.
• Insira o URL do endpoint.
• Configure os Cabeçalhos, Parâmetros e o Tipo de mensagem no formato apropriado com base na chamada de API que você gostaria de realizar.
• Clique em Testar e Salvar.
• Em seguida, 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 no qual essa solicitação de API deve ser testada e clique em OK. Ela 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 então exibidos. Verifique o comportamento esperado da API e clique em Salvar.