Conector REST Paycor

Documentação da API

A referência da API do fornecedor abrange os pontos de acesso deste conector.

Configuração do Paycor

O processo de criação e iniciação de uma aplicação API no Paycor é um pouco mais complexo do que o de outros fornecedores REST. Certifique-se de que segue os passos descritos na respetiva página de início rápido

Os valores essenciais que tem de registar são:

• Application OAuth Client ID
• Application OAuth Client Secret
• APIm Subscription Key
• Scope Key da versão current da aplicação

Cuidado

Não se esqueça de “ativar” a aplicação para permitir a sua utilização

Ative-a aqui, escolhendo Produção ou Sandbox consoante a sua necessidade:

Ambiente	URL do formulário de ativação
Sandbox	https://hcm-demo.paycor.com/AppActivation/ClientActivation
Produção	https://hcm.paycor.com/AppActivation/ClientActivation

Perigo

Se tiver várias organizações no Paycor, vai precisar de inícios de sessão separados para cada organização. NÃO os una. O Developer Portal precisa de um início de sessão único e dedicado para cada organização, para criar uma aplicação específica da organização para acesso REST.

Configuração

Estes campos aparecem ao criar ou editar esta ligação.

Identificação

Campo	Tipo	Descrição
Nome	Texto	Nome de apresentação desta ligação.
Alias	Texto (várias linhas)	Alias ou notas opcionais sobre a ligação.
Está ativa	Comutador	Indica se a ligação está ativada. Desative para a suspender sem a eliminar.
Só de leitura na BD	Comutador	Restringe a ligação a operações de leitura.
Tipo de acesso	Seleção	Nível de acesso desta ligação: só de leitura, só de escrita ou de leitura e escrita.

Credenciais

Introduza os três valores que registou durante a Configuração do Paycor. Não introduz um anfitrião nem um URL de token — o PlaidCloud fornece o anfitrião da API do Paycor e o ponto de acesso de tokens OAuth2.

Campo	Tipo	Descrição
ID de cliente OAuth2	Texto	O Application OAuth Client ID do registo da sua aplicação no Paycor.
Segredo de cliente OAuth2	Palavra-passe	O Application OAuth Client Secret. Guardado cifrado.
Chave de subscrição Paycor	Texto	A APIm Subscription Key da sua aplicação Paycor.

Autenticação

O Paycor utiliza OAuth2 com uma concessão de código de autorização, pelo que introduzir as credenciais é apenas a primeira metade — também tem de concluir um início de sessão único no Paycor que autoriza o PlaidCloud a extrair os seus dados.

1. Introduza as credenciais e guarde. Preencha os três valores acima e guarde a ligação.
2. Ligue. Clique em Ligar ao Paycor. O PlaidCloud abre uma janela de autorização do Paycor. O botão fica disponível depois de a ligação ser guardada.
3. Inicie sessão e aprove. Inicie sessão no Paycor nessa janela e aprove o acesso. O Paycor reencaminha-o para o PlaidCloud, que guarda um token de atualização na ligação e o utiliza para obter tokens de acesso automaticamente a partir de então.

Cuidado

Permita as janelas pop-up para o PlaidCloud. Se a janela de autorização for bloqueada, o PlaidCloud informa-o — permita as janelas pop-up e clique novamente em Ligar ao Paycor.

O anfitrião da API (apis.paycor.com) e o ponto de acesso de tokens (https://apis.paycor.com/sts/v1/common/token) são geridos pelo PlaidCloud. Não existem campos de URL para preencher e não deverá ser necessário editá-los.

Reautorizar uma ligação expirada

O acesso ao Paycor pode caducar — o token de atualização expira ou é revogado, ou a aplicação Paycor é desativada. Quando isso acontece, os fluxos de trabalho que utilizam a ligação deixam de se autenticar e falham. Para a restaurar:

1. Confirme que a aplicação Paycor continua ativada (consulte os URL de ativação em Configuração do Paycor).
2. Abra a ligação e clique em Ligar ao Paycor para repetir a autorização do Paycor, inicie sessão e aprove. Isto cria um novo token de atualização e a ligação é retomada.

Perigo

Estabeleça e repare as ligações Paycor através deste formulário de ligação. Editar a ligação subjacente através de um editor REST genérico ou da API pode substituir o URL de token gerido e interromper a autenticação.