Como configurar a integração BambooHR no ADManager Plus

Pré-requisitos

• O BambooHR utiliza Chaves de API para autorizar as requisições de API.

Privilégios

Importar usuários (ação de entrada): A conta utilizada na autorização deve ter permissão para ler todas as contas de usuário.

Para executar qualquer ação ou consulta no BambooHR (ação de saída): A conta usada deve ter permissão para realizar a ação desejada.

Configuração de autorização

• Faça login no ADManager Plus e acesse Directory/Application Settings.
• Em Application Integrations, localize e selecione BambooHR.
• Ative a opção Enable BambooHR Integration.
• Ative a opção Enable BambooHR Integration.
• Na página BambooHR Configuration, clique em Authorization..
• No tipo de autorização Autenticação básica, insira a chave de API no campo do nome de usuário. Use qualquer string gerada aleatoriamente como senha.
• Clique em Configure.

Configuração de webhook de entrada

O webhook de entrada permite ao ADManager Plus obter dados de usuários diretamente do BambooHR. O mapeamento de atributos configurado nesta seção pode ser selecionado como fonte de dados durante a configuração de automações para executar a ação desejada na lista de usuários retornada pela resposta da API. Para configurar um webhook de entrada para o BambooHR:

• Em Inbound Webhook, clique em BambooHR Endpoint Configuration.
• Na aba Endpoint Configuration você encontrará um endpoint pré-configurado BambooHR USERS ENDPOINT, com campos para a URL do endpoint, Método de API, Cabeçalhos, e Parâmetros fields to fetch user accounts from BambooHR. Para utilizá-lo, substitua {companyName} pelo nome da sua empresa no BambooHR no campo Endpoint URL field. No entanto, se desejar usar um novo endpoint para importar usuários, clique em + Add API endpoint e preencha os campos obrigatórios conforme as referências de API do BambooHR. Clique aqui para saber como.
• Verifique o corpo da requisição pré-preenchido, onde está a lista de campos a serem integrados; se precisar de outros campos, inclua-os nessa lista de "campos".

  

  Nota:

  • O par de valores de chave de API é pré-configurado como um cabeçalho para autenticação de solicitações de API, conforme configurado durante a Configuração de Autorização.
  • Macros: É possível adicionar macros na configuração do endpoint para alterá-lo dinamicamente por meio do componente de seleção de macros.
  • Consulte as referências de API do BambooHR e configure cabeçalhos ou parâmetros, se necessário.
• Após concluir, clique em Test & Save. A janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos pela chamada da API. Clique em Proceed.

  Nota:

  • Consulte a referência de API do BambooHR para verificar qual Corpo de mensage deve ser configurado para retornar apenas os dados desejados.
• Clique em Data Source - LDAP Attribute Mapping para vincular endpoints e mapear atributos LDAP do AD aos atributos correspondentes no BambooHR.

  [O ADManager Plus também permite personalizar o formato de atributos importados do BambooHR.]

• Clique em + Add New Configuration e faça o seguinte:
  • Insira o Nome da configuração e a Descrição, e selecione a Categoria de automação no menu suspenso.
  • No campo Select Endpoint, escolha o endpoint desejado e defina uma Chave primária única para o usuário (por exemplo, employeeIdentifier).
  Nota: Quando vários endpoints estiverem configurados, essa chave deve manter o mesmo valor em todos eles.
  • No campo Attribute Mapping, selecione o atributo LDAP Attribute Name no menu suspenso e associe-o à coluna correspondente no BambooHR.
  • Se quiser criar um formato personalizado, clique em Mapping Attribute.
  • Clique em Save..
• Configure uma automação informando a ação desejada, a frequência de repetição e mapeamento de atributos criado acima.

Configuração de webhook de saída

O webhook de saída permite atualizar no BambooHR as alterações feitas no AD via ADManager Plus e sincronizá-las com o AD.

Para configurar um webhook de saída para o BambooHR:

• Em Outbound Webhook, clique em BambooHR Webhook Configuration.
• Clique em + Add Webhook.
• Insira um nome e uma descrição para este webhook.
• Defina a ação a ser executada e consulte as referências de API do BambooHR para obter detalhes como URL, Cabeçalhos, Parâmetros e demais requisitos.
• Selecione, no menu suspenso, o método HTTP que permitirá executar a ação desejada no endpoint.
• Insira a URL do endpoint.
• Configure Cabeçalhos, Parâmetros e Corpo da mensagem no formato apropriado para a chamada de API desejada.
• 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 para testar a chamada de API e clique em OK. Isso enviará uma solicitação em tempo real para a URL do endpoint e aplicará as modificações configuradas aos objetos selecionados.
• Os detalhes da solicitação e da resposta do webhook serão exibidos. Verifique se a API está respondendo corretamente e clique em Save.
• Os webhooks configurados podem ser incorporados a Modelos de Orquestração—permitindo automações agendadas ou acionadas por eventos —para que a ação definida no webhook de saída seja executada sequencialmente em um grupo de usuários ou em usuários individuais.
Nota: use macros para enviar os dados do objeto no qual o webhook é executado.