Mit unserer leistungsstarken REST-API können Sie mit einfachen HTTPS-Abfragen Daten von und an den Bewerbungsmanager senden und die Antworten einsehen. Lesen Sie in diesem Artikel, wie Sie die Funktion einrichten können.
Wichtige Information für Bestandskund·innen!Seit dem 09.09.2022 ist Prescreen unter onlyfy.io zu erreichen. Die Domains enden auf onlyfy.io bzw. onlyfy.jobs. Diese Domains werden automatisch weitergeleitet, somit müssen Sie diese aktuell nicht umstellen. Von der Umstellung nicht betroffen ist die Domain https://api.prescreenapp.io. Diese bleibt derzeit unverändert. Bitte nutzen Sie für REST-API Calls bis auf Widerruf weiterhin die Domain https://api.prescreenapp.io. |
Wie richte ich die R/W REST API ein?
Im ersten Schritt beantragen Sie die Aktivierung der API-Funktion in Ihrem Account bei unserem Customer Service Team.
[hint]
Arbeiten Sie im Auftrag eines unserer Kund·innen?
Bitten Sie Ihre Ansprechperson, einen API-Schlüssel für Sie im onlyfy Bewerbungsmanager Account zu generieren. Aus Datenschutzgründen gewähren wir den API-Zugang nur bestehenden Nutzer·innen des Bewerbungsmanagers und ihren jeweiligen Konten.
[/hint]
Sobald Sie den Zugang erhalten haben, gehen Sie zu „Einstellungen“ (1) > „Integration“ (2) > „Rest API“ (3) und klicken Sie auf „Neuen Key erzeugen“ (4) um einen neuen API-Schlüssel zu erstellen.
Legen Sie nun die Zugriffsrechte für den API-Schlüssel fest. Achten Sie darauf, dass der Zugang zu sensiblen Daten (z.B. Verwaltung von Nutzer·innen) nur in den Fällen gewährt wird, in denen er erforderlich ist.
[hint]
Werfen Sie einen Blick auf unsere API Dokumentation.
[/hint]
[tip]
Nutzen Sie die Vorteile unserer Test-Schnittstelle: oben rechts auf der Seite können Sie Ihren API-Schlüssel eingeben, Anfragen senden und die Antwort einsehen.
[/tip]