Como integrar o Paylocity ao ADManager Plus

Pré-requisitos:

• O Paylocity usa o OAuth 2.0 para autorizar solicitações de API
• Requer credenciais de client_id e client_secret para autorização

Privilégios:

• Para importar usuários (ação de entrada): a conta usada na autorização deve ter permissão para ler todas as contas de usuário.
• Para executar qualquer ação ou consulta no Paylocity (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 a guia Automation.
• No painel esquerdo, em Configuration, clique em Application Integrations.
• Em Enterprise Applications, clique em Paylocity.
• Ative o botão Enable Paylocity Integration.
• Na página Zoom Configuration, clique em Authorization.
• Execute as etapas para gerar o client_id e o client_secret a partir do Paylocity e cole os dados nos respectivos campos de valor.
• Clique em Configure.

Configuração de webhook de entrada

O webhook de entrada permite ao ADManager Plus obter dados de usuários diretamente do Paylocity. O mapeamento de atributos definido aqui poderá ser selecionado como fonte de dados ao configurar automatizaçõ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 Paylocity:

• Em Inbound Webhook, clique em Paylocity Endpoint Configuration.
• Na guia Endpoint Configuration, você encontrará um endpoint pré-configurado, o ENDPOINT DE USUÁRIOS do Paylocity, com campos para a URL do endpoint, Método de API, Cabeçalhos e Parâmetros para obter contas de usuário do Paylocity. Se você desejar usar esse endpoint pré-configurado, substitua {host} e {port} pelo respectivo nome do host e pelo número da porta da sua instância do Paylocity no campo Endpoint URL. No entanto, se você desejar usar um novo endpoint para importar usuários, você poderá configurar um usando o botão + Add API endpoint e preenchendo os campos obrigatórios de acordo com as referências de API do Paylocity. Clique aqui para saber como.

Nota:

• O par chave-valor da API já vem pré-configurado como cabeçalho para autenticar as 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 Paylocity e configure cabeçalhos e parâmetros adicionais, se necessário.
• Uma vez feito isso, clique em Endpoint URL. Uma janela de resposta exibirá todos os parâmetros solicitados que podem ser obtidos usando a chamada de API. Clique em Proceed.

Nota:

• Consulte as referências de API do Paylocity para visualizar quais parâmetros devem ser configurados para obter apenas parâmetros específicos.
• Você pode configurar diversos endpoints para o Paylocity usando o botão + Add API endpoint. Clique aqui para saber como.
• Clique em Data Source - LDAP Attribute Mapping para vincular endpoints e mapear atributos LDAP do AD aos respectivos atributos no Paylocity.
[O ADManager Plus também permite que você personalize formatos de atributo do Paylocity]
• 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, selecione o endpoint desejado e uma chave primária exclusiva a cada 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 no menu suspenso Nome do atributo LDAP e associe ele à coluna correspondente no Paylocity.
  • Se você quiser criar um novo formato personalizado para isso, clique em Add New Format Attribute.
  • Clique em Save.

Configuração de webhook de saída

Webhooks de saída permitem que você envie mudanças feitas no AD para o Paylocity e execute tarefas no Paylocity — tudo a partir do ADManager Plus. Os webhooks configurados nesta seção podem ser incluídos em Modelos de orquestração, que, por sua vez, podem ser usados durante automações acionadas por eventos e agendadas. Eles também podem ser aplicados diretamente nos usuários desejados para executar uma sequência de ações neles (Management > Advanced Management > Orchestration).

Para configurar webhooks de saída para o Paylocity:

• Em Outbound Webhook, clique em Paylocity Webhook Configuration.
• Clique em + Add Webhook.
• Insira um nome e uma descrição para este webhook.
• Decida sobre a ação que deve ser executada e consulte as referências de API do Paylocity para obter os detalhes de API, tais como URL, cabeçalhos, parâmetros e outros requisitos que serão necessários.
• Selecione, no menu suspenso, o método HTTP que permitirá executar a ação desejada no endpoint.
• Insira a URL do endpoint.
• Configure os cabeçalhos, os parâmetros e o tipo de mensagem no formato apropriado com base na chamada de API que você deseja 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 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.