Die Nutzung unserer API erfordert Vorwissen/Erfahrung in APIs und wie man damit arbeitet. Dieser Artikel erklärt, was die Teamtailor API ist und wie du damit arbeiten kannst.
Was ist die Teamtailor API und was kann sie?
Unsere offene Teamtailor API folgt der JSON API-Spezifikation und kann zum Importieren, Bearbeiten und Exportieren von Informationen aus/in euer Teamtailor-Konto verwendet werden. Das könnte alles Mögliche sein, vom Abrufen einer Stellenliste, dem Aktualisieren einer Stelle, dem Aktualisieren eines Nutzers - sogar das Erstellen eines Nutzers.
Teamtailor bietet zwei Regionen für die Datenverarbeitung und -speicherung: EU (Irland) und US West (Oregon). Die API-URL, die du in deinen API-Aufrufen verwendest, hängt von der Region ab, in der euer Konto gespeichert ist.
EU Region: api.teamtailor.com
US West Region: api.na.teamtailor.com
Erste Schritte
Um unsere API nutzen zu können, muss ein API-Schlüssel in Einstellungen → Integrationen → API-Schlüssel in eurem Teamtailor-Konto generiert werden. Beachte, dass diese Seite nur für Benutzer mit Unternehmens-Admin Rolle zugänglich ist.
Hier kannst du sowohl neue Schlüssel erstellen als auch bestehende löschen. Beachte, dass sobald ein API-Schlüssel erstellt wurde, er nicht bearbeitet, sondern nur gelöscht werden kann.
Um einen API-Schlüssel zu erstellen, klicke auf + Neuer API-Schlüssel in der oberen rechten Ecke.
Es gibt drei verschiedene Arten von Schlüsseln mit unterschiedlichen Berechtigungen und Typen. Diese sind alle in unserer Dokumentation hier erklärt und lauten wie folgt:
Berechtigungen:
Öffentlich - Zugriff auf alle öffentlichen Daten, die auf der Karriereseite verfügbar sind
Intern - öffentliche + interne Daten (z.B. aus der Liste entfernte/interne Stellen, Abteilungen, Standorte)
Admin - Zugriff auf alles in einem Konto
Typen:
Lesen - nur Informationen abrufen und ‚lesen‘
Schreiben - nur neue Informationen erstellen
Lesen/Schreiben - kann beides
Anwendungsbeispiel
Wenn du z. B. eine Liste von Stellen über unsere API abrufst und nur eine Liste von veröffentlichten Stellen abrufen möchtest, ist es gut, einen Öffentlichen Lese Schlüssel zu verwenden, da dieser dir Zugang zu öffentlichen Daten auf der Karriereseite gibt, wie z. B. veröffentlichte Stellen. Solltest du stattdessen eine Liste aller Standorte abrufen wollen, unabhängig davon, ob sie öffentlich sind oder nicht - dann benötigst du einen Schlüssel mit mindestens Intern Lesen-Berechtigung.
Einige Daten sind aus Sicherheitsgründen sehr restriktiv (z. B. Informationen/Daten über Kandidaten) und können nur mit einem Schlüssel mit Admin-Berechtigung abgerufen werden. Wenn das der Fall ist, wird dies immer in der API-Dokumentation angegeben.
Unterstützung/Support
Mit den verfügbaren Endpunkten in unserer Dokumentation sollte alles, was für eine Aktion erforderlich ist, in der Dokumentation enthalten sein, mit Beispielen die getestet werden können, sofern nötig.
Solltest du allgemeine Fragen zur API-Dokumentation haben, kannst du dich gerne an unseren Support unter support@teamtailor.com wenden, aber bitte beachte, dass wir keinen Support bei der API-Implementierung anbieten.
Wenn etwas nicht in der Dokumentation angeführt ist, ist es höchstwahrscheinlich auch nicht für die Implementierung verfügbar. Benutzerdefinierte Skripte oder weitere Integrationen können mit den Anfragen, die in unseren öffentlichen API-Skripten verfügbar sind, kombiniert werden. Wie genau ihr das angeht, liegt allerdings ganz bei euch.