API-Anbindung

In diesem Artikel werden wir alle Aspekte im Zusammenhang mit der API-Integration behandeln:

• Aktivierung
• Dokumentation
• Testumgebung
• Verwaltung von API-Tokens
• Einsatz in der Produktion

Wichtig: In diesem Artikel geht es um die Kern-API, mit der du auf die Mitarbeiterdaten in deinem Kenjo-Konto zugreifen kannst. Diese API ist eine andere als die öffentliche API, die für die Karriereseite verwendet wird.

Aktivierung

Um die API-Aktivierung in deinem Kenjo-Konto anzufordern, musst du nur zu Einstellungen > Integrationen gehen und die Schaltfläche neben API anklicken.

Du wirst benachrichtigt, dass unser Support-Team für die Aktivierung kontaktiert werden wird:

Wichtig: Die API ist auf den Connect-Plan beschränkt. Du kannst die Aktivierung auch dann anfordern, wenn du einen anderen Tarif hast, aber bitte beachte, das du aufgefordert wirst deinen Tarif zu aktualisieren, wenn du die Funktion nutzen möchtest.

Dokumentation

Während du darauf wartest, dass unser Support-Team deine Anfrage bearbeitet, ist es vielleicht ein guter Moment, unsere Dokumentation zur API durchzulesen. Dort findest du alle Informationen, die du für die Arbeit mit dieser Funktion und allen verfügbaren Endpunkten benötigen.

Da unser Team unsere API-Integration ständig verbessert, wird diese Dokumentation laufend aktualisiert. Prüfe sie regelmäßig, um sicherzustellen, dass du die neueste Version hast.

Testumgebung

Da eure Entwickler die Integration wahrscheinlich testen müssen, können wir euch eine Testumgebung (Sandbox) zur Verfügung stellen, in der ihr alle notwendigen Tests durchführen können, ohne eure echten Kontodaten zu gefährden. 

Die Verwendung einer Testumgebung wird dringend empfohlen, bevor du die API-Integration in deinem echten Kenjo-Konto aktivierst. Wenn du eine Testumgebung wünschst, lass es uns bitte wissen, und wir werden euch die Details zur Verfügung stellen.

Verwaltung von API-Tokens

Sobald der Antrag auf API-Aktivierung genehmigt wurde, folge diesen Schritten, um einen neuen API-Schlüssel zu generieren:

Melde dich in deinem Kenjo-Konto an und navigiere zu Einstellungen > Integrationen > API. Du wirst feststellen, dass du nun eine Einstellungsoption haben, wo vorher nichts war:

Wenn du auf Einstellungen klickst, wirst du zum Abschnitt API-Schlüssel-Einstellungen weitergeleitet:

Um euren ersten API-Schlüssel zu erzeugen, klicke auf NEUEN API-Schlüssel GENERIEREN. Du kannst bis zu 5 Schlüssel mit verschiedenen Zugriffsebenen generieren.

Jeder API-Schlüssel ist erfordert:

• Alias: Um eure API-Schlüssel einfach zu identifizieren und zu verwalten, gebe während des Generierungsprozesses einen eindeutigen Alias oder Namen für jeden Schlüssel an.
• Zugriffsstufe: Definiere die Zugriffsebene, die der API-Schlüssel haben soll. Gebe unbedingt die benutzerdefinierten Berechtigungen und Einschränkungen an, die mit diesem Schlüssel verbunden sind. Standardmäßig hat jeder API-Schlüssel Zugriff auf die Endpunkte Unternehmen, Büro, Abteilungen, Mitarbeiter, Team, Bereich, Kalender und benutzerdefinierte Felder.

Wichtig: Kopiere den API-Schlüssel vor dem Speichern an einen sicheren Ort. Nach dem Speichern wird der API-Schlüssel aus Sicherheitsgründen nicht mehr sichtbar sein.

Einsatz in der Produktion

Sobald ihr mit der Testumgebung fertig seid, kannst du uns unter [email protected] erreichen, um die API-Aktivierung in deinem Kenjo-Konto zu beantragen.

Hinweis: Bitte habe Verständnis dafür, dass nach der Aktivierung, der API-Integration, in eurem Kenjo-Konto, die Nutzung und die damit verbundenen Aktionen in eurer alleinigen Verantwortung liegen. Wir empfehlen daher, mit Vorsicht vorzugehen und nur in einer Testumgebung zu testen.