Einstiegsleitfaden für die REST-API

HireHop basiert auf einer API. Das bedeutet, dass alles, was Sie in HireHop tun können, auch über die umfangreiche API möglich ist. Um auf die REST-API zuzugreifen, benötigen Sie lediglich ein Benutzertoken, das als GET- oder POST-Anfrage an den entsprechenden URL-Endpunkt übergeben wird.

API-Tokens

Um ein API-Token zu generieren, rufen Sie die Seite „Einstellungen“ auf und wählen Sie den Reiter „Benutzer“ aus. Wählen Sie einen Benutzer aus oder erstellen Sie einen neuen. Während dieser spezifische Benutzer ausgewählt ist, klicken Sie auf die Schaltfläche „Menü“ und wählen Sie die Option „API-Token“, um ein Token zu generieren. Das Token wird daraufhin angezeigt und kann über die Kopierschaltfläche in die Zwischenablage kopiert werden.

Das Token wird ungültig, wenn Sie die E-Mail-Adresse oder das Passwort des ausgewählten Benutzers ändern oder sich später bei diesem Benutzer anmelden.  Um dies zu verhindern, sollten Sie einen dedizierten API-Benutzer erstellen und diesem aus Sicherheitsgründen die entsprechenden Berechtigungen zuweisen, um ihn auf die Dinge zu beschränken, für die Sie die API nicht verwenden.

Aus Sicherheitsgründen sollten Sie das Token niemals im Frontend-JavaScript-Code verwenden; es sollte nur serverseitig eingesetzt werden. Wenn ein Hacker das Token erlangt, kann er Ihre Daten bei HireHop einsehen und verändern. Bewahren Sie Ihr Token daher geheim.  Sollte Ihr Token doch einmal kompromittiert werden, ändern Sie einfach das Passwort des API-Benutzers und generieren Sie ein neues Token.

Verwendung eines Tokens

Ein Token sollte als GET- oder POST-Parameter mit der Bezeichnung „token“ übergeben werden.  Um beispielsweise Auftragsdaten für den Auftrag Nummer 52 zu laden, ruft HireHop den API-Endpunkt auf:

https://myhirehop.com/php_functions/job_refresh.php?job=52

Wenn Sie denselben Endpunkt mit einem Token aufrufen möchten, lautet die URL:

https://myhirehop.com/php_functions/job_refresh.php?job=52&token=dqwejk5GVT65909bHHBN7922pq5hxjm%207hmn

Denken Sie daran, dass Sie das Token bei der Übergabe per GET (als URL-Parameter wie oben) zuvor mit einem Tool wie codieren müssen:URL-Decoder/Encoder.

Daten senden (POST)

Um Daten in HireHop zu erstellen oder zu bearbeiten, müssen Sie eine POST-Anfrage verwenden. Beim Senden von Daten sollten Sie nur die Felder angeben, die Sie ändern möchten. Um beispielsweise einen Auftrag zu erstellen oder zu bearbeiten, verwenden Sie den Endpunkt:

https://myhirehop.com/php_functions/job_save.php

Wenn Sie den Parameter „job“ auf „0“ setzen oder weglassen, wird ein neuer Auftrag erstellt; jeder andere Wert bearbeitet die entsprechende Auftragsnummer. Um also den Firmennamen im Auftrag Nummer 52 zu bearbeiten, sollten die POST-Daten wie folgt aussehen:

{
"job" : 52,
"name" : "New Name",
"token" : "dqwejk5GVT65909bHHBN7922pq5hxjm=-7hmn"
}

API-Endpunkte

Viele API-Endpunkte sind in der API-Dokumentation dokumentiert, und viele weitere werden folgen. Um den Endpunkt für eine Aufgabe zu ermitteln, verwenden Sie in der HireHop-Anwendung die Browser-Netzwerkkonsole, um die Netzwerkaufrufe und die gesetzten Parameter zu überprüfen. Eine ausführliche Anleitung zu den URL-Endpunkten wird in Kürze veröffentlicht.