Paycor-REST-Konnektor
API-Dokumentation
Abschnitt betitelt „API-Dokumentation“Die API-Referenz des Herstellers behandelt die Endpunkte dieses Konnektors.
Paycor-Einrichtung
Abschnitt betitelt „Paycor-Einrichtung“Das Verfahren zum Anlegen und Initiieren einer Paycor-API-Anwendung ist aufwendiger als bei anderen REST-Anbietern. Gehen Sie unbedingt die Schritte auf der Quick-Start-Seite von Paycor durch.
Folgende Schlüsselwerte müssen Sie festhalten:
- OAuth-Client-ID der Anwendung
- OAuth-Client-Secret der Anwendung
- APIm-Subscription-Key
- Scope-Key der
current-Version der Anwendung
Aktivieren Sie sie hier und wählen Sie je nach Bedarf Production oder Sandbox:
| Umgebung | URL des Aktivierungsformulars |
|---|---|
| Sandbox | https://hcm-demo.paycor.com/AppActivation/ClientActivation |
| Production | https://hcm.paycor.com/AppActivation/ClientActivation |
Konfiguration
Abschnitt betitelt „Konfiguration“Diese Felder werden angezeigt, wenn Sie diese Verbindung erstellen oder bearbeiten.
Identifikation
Abschnitt betitelt „Identifikation“| Feld | Typ | Beschreibung |
|---|---|---|
| Name | Text | Anzeigename für diese Verbindung. |
| Alias | Text (mehrzeilig) | Optionaler Alias oder Notizen zur Verbindung. |
| Ist aktiv | Schalter | Gibt an, ob die Verbindung aktiviert ist. Deaktivieren Sie sie, um sie zu pausieren, ohne sie zu löschen. |
| Db schreibgeschützt | Schalter | Beschränkt die Verbindung auf Lesevorgänge. |
| Zugriffstyp | Auswahl | Zugriffsebene für diese Verbindung: schreibgeschützt, nur schreibend oder lesend und schreibend. |
Zugangsdaten
Abschnitt betitelt „Zugangsdaten“Geben Sie die drei Werte ein, die Sie bei der Paycor-Einrichtung festgehalten haben. Sie geben weder einen Host noch eine Token-URL ein – PlaidCloud stellt den Paycor-API-Host und den OAuth2-Token-Endpunkt für Sie bereit.
| Feld | Typ | Beschreibung |
|---|---|---|
| OAuth2-Client-ID | Text | Die OAuth-Client-ID der Anwendung aus Ihrer Paycor-App-Registrierung. |
| OAuth2-Client-Secret | Passwort | Das OAuth-Client-Secret der Anwendung. Wird verschlüsselt gespeichert. |
| Paycor-Subscription-Key | Text | Der APIm-Subscription-Key Ihrer Paycor-Anwendung. |
Authentifizierung
Abschnitt betitelt „Authentifizierung“Paycor verwendet OAuth2 mit einem Authorization-Code-Grant. Die Eingabe der Zugangsdaten ist daher nur die erste Hälfte – Sie führen außerdem eine einmalige Anmeldung bei Paycor durch, die PlaidCloud autorisiert, Ihre Daten abzurufen.
- Zugangsdaten eingeben und speichern. Tragen Sie die drei obigen Werte ein und speichern Sie die Verbindung.
- Verbinden. Klicken Sie auf Mit Paycor verbinden. PlaidCloud öffnet ein Paycor-Autorisierungsfenster. Die Schaltfläche steht zur Verfügung, sobald die Verbindung gespeichert wurde.
- Anmelden und genehmigen. Melden Sie sich in diesem Fenster bei Paycor an und genehmigen Sie den Zugriff. Paycor leitet Sie zurück zu PlaidCloud, das ein Refresh-Token in der Verbindung speichert und damit ab dann automatisch Zugriffstoken beschafft.
Der API-Host (apis.paycor.com) und der Token-Endpunkt (https://apis.paycor.com/sts/v1/common/token) werden von PlaidCloud verwaltet. Es gibt keine URL-Felder auszufüllen, und Sie sollten sie nicht bearbeiten müssen.
Abgelaufene Verbindung erneut autorisieren
Abschnitt betitelt „Abgelaufene Verbindung erneut autorisieren“Der Paycor-Zugriff kann ablaufen – das Refresh-Token läuft ab oder wird widerrufen, oder die Paycor-Anwendung wird deaktiviert. Dann können sich Workflows, die die Verbindung verwenden, nicht mehr authentifizieren und schlagen fehl. So stellen Sie sie wieder her:
- Prüfen Sie, ob die Paycor-Anwendung weiterhin aktiviert ist (siehe die Aktivierungs-URLs unter Paycor-Einrichtung).
- Öffnen Sie die Verbindung und klicken Sie auf Mit Paycor verbinden, um die Paycor-Autorisierung erneut auszuführen. Melden Sie sich dann an und genehmigen Sie. Dadurch wird ein neues Refresh-Token erzeugt, und die Verbindung funktioniert wieder.