Inhaltsverzeichnis
Einleitung
Eine API, kurz für Application Programming Interface, dient dem formalisierten Austausch von Daten zwischen Softwareprogrammen und Anwendungen. Mit Hilfe eines API-Tokens haben Sie also die Möglichkeit, eine API-Integration mit einem Dritten herzustellen, sofern dieser nicht bereits eine Integration mit CrewPlanner hat.
Angenommen, Sie als CrewPlanner-Kunde haben einen Anbieter, der noch keine Integration zu CrewPlanner hat, dann bieten wir Ihnen die Möglichkeit, über ein Kunden- oder Agentur-API-Token dennoch bestimmte Informationen von CrewPlanner abzurufen und beliebig zu verarbeiten.
Diese API-Tokens können Sie selbst über die Seite API-TOKENS erstellen und verwalten, die Sie im Menü EINSTELLUNGEN auf der rechten Seite finden. Auf dieser Seite finden Sie auch eine Dokumentation, die es Dritten ermöglicht, eine Client-API zu erstellen.
Eine API-Integration vorbereiten
Oben auf der Seite API-Token haben Sie die folgenden Optionen: ERSTELLEN SIE EIN API-TOKEN und ZUR DOKUMENTATION.
Bevor Sie ein API-Token erstellen, sollten Sie Ihrem Drittanbieter zunächst die erforderlichen Informationen zur Verfügung stellen, damit dieser die Intmit dem API-Token vorbereiten kann. Wählen Sie daher zunächst ZU DOKUMENTATION, wo Sie die erforderlichen Informationen finden.
Sie erhalten dann drei Optionen, die zu den relevanten Informationen für die Art der Integration führen, die Sie erstellen möchten:
Client API: dieser Integration ermöglicht die Weiterleitung von Leistungsdaten an Dritte
Payroll API: dieser Integration verbindet Payroll-Unternehmen mit ihren Kunden in CrewPlanner
Agency API: dieser Link verbindet Arbeitsagenturen oder Projektagenturen mit ihren Kunden in CrewPlanner
Es ist daher wichtig, dass Sie die richtige Dokumentation mit Ihrem Lieferanten oder Dritten teilen.
Ein API-Token erstellen
Um ein API-Token in CrewPlanner zu erstellen, gehen Sie bei den drei verschiedenen Typen gleich vor. Wenn Sie jedoch eine Integration zu einer Payroll-, Staffing- oder Projekt-Agentur wünschen, die noch nicht an CrewPlanner angeschlossen ist, sollten Sie uns zuerst unter [email protected] kontaktieren!
Wir werden daher im Folgenden nur darauf eingehen, wie Sie eine Client API erstellen:
Um Leistungsdaten von CrewPlanner abrufen zu können, benötigen Sie eine Client API. Anhand der entsprechenden Dokumentation kann Ihr Anbieter auf seiner Seite die notwendigen Vorbereitungen treffen, um dieses API-Token zu erstellen.
Sobald dies geschehen ist, erstellen Sie einfach ein API-Token für diesen Anbieter, indem Sie ERSTELLEN SIE EIN API-TOKEN wählen. Sie werden dann auf die nächste Seite weitergeleitet:
Führen Sie dann die folgenden Schritte aus:
Geben Sie dem Token einen für Sie erkennbaren Namen, zum Beispiel den des Dritten, für den Sie das API-Token erstellen.
Wählen Sie den Zugriff aus, den Sie gewähren möchten, indem Sie das entsprechende Kästchen ankreuzen; derzeit unterstützen wir eine Integration für die Berichte über Ihre Arbeitsstunden und Mitarbeiterdaten.
Erstellen Sie das Token, indem Sie SPEICHERN wählen.
Die API-Token-Übersicht
Sobald Sie das Token erstellt haben, erscheint es in der Token-Übersicht auf der API-Token-Seite. Welche Informationen können Sie hier finden:
Name: Der Name, den Sie bei der Erstellung des Tokens angegeben haben.
Zugriff: Hier wird angezeigt, auf welche Informationen Sie Zugriff gewähren.
Zuletzt verwendet am: Hier können Sie nachsehen, wann dieses Token zuletzt von der dritten Partei verwendet wurde.
Bleistift-Symbol: Wählen Sie dieses Symbol, um das Token zu bearbeiten oder einzusehen. Wir werden dies in Kürze genauer erläutern.
Mülleimer-Symbol: Mit diesem Symbol können Sie das Token löschen.
Ein API-Token einsehen und kopieren
Wie bereits erwähnt, können Sie ein API-Token einsehen, indem Sie in der Übersicht das Bleistift-Symbol neben dem betreffenden Token auswählen.
Dadurch gelangen Sie auf die folgende Seite, auf der Sie das geheime Token auf der rechten Seite finden.
Sobald Sie auf das Klemmbrett-Symbol klicken, wird dieses Token vollständig sichtbar und für Sie kopiert.
Auf diese Weise können Sie den Token mit Dritten teilen.
CrewTip! Wir empfehlen Ihnen, mit diesem Token sehr vorsichtig umzugehen, da Sie damit Ihre sensiblen und persönlichen Daten weitergeben können.
Mit diesem geheimen Schlüssel kann Ihr Partner jederzeit alle Berichtsdaten aus Ihrer Umgebung extrahieren. Er kann sich jedoch dafür entscheiden, diese Berichte beispielsweise nur wöchentlich oder monatlich abzurufen.
Es ist also Sache des Drittanbieters, einen eigenen Link zu erstellen, der mit Hilfe der API-Dokumentation und des geheimen Schlüssels, den Sie für ihn erstellen, eine Integration mit der CrewPlanner-Logik ermöglicht.
Ein API-Token löschen
Wie bereits berichtet, können Sie ein API-Token löschen, indem Sie das Mülleimer-Symbol in der Übersicht auswählen.
Sobald Sie dieses Symbol auswählen, öffnet sich das folgende Pop-up:
Wenn Sie dann auf Bestätigen klicken, wird dieses API-Token gelöscht und der Dritte hat keinen Zugriff mehr auf Ihre Daten.
Hoffentlich haben wir Ihnen mit diesem Artikel geholfen!
Wenn Sie noch Fragen haben, werfen Sie zunächst einen Blick in unsere Crew Academy. Hier finden Sie vielleicht die Antwort in einem unserer Artikel.