API & Integration

RESTful API

Die API (Application Programming Interface) ermöglicht es Entwicklern, auf die Funktionen und Daten unseres Systems zuzugreifen und diese in eigenen Anwendungen zu integrieren. Diese Dokumentation bietet eine detaillierte Übersicht über die verfügbaren Endpunkte, Authentifizierungsmethoden, Anforderungs- und Antwortformate sowie Beispiele für die Integration in Ihre Anwendungen.

Swagger Endpunkt Dokumentation:

https://app.hello-perso.com/swagger-ui/index.html#/

API-Zugriff vorbereiten

Um auf die API zugreifen zu können, sind folgende Schritte erforderlich:

  1. Erstellen einer Rolle für die API:

    • Navigiere in der Verwaltung zu Rollen & Rechte.

    • Erstelle eine neue Rolle, die speziell für den API-Zugriff gedacht ist.

    • Weise dieser Rolle die notwendigen Berechtigungen zu, um auf die API-Funktionen zugreifen zu können.

  2. Generierung eines API-Keys:

    • Gehe in der Verwaltung zu API-Keys.

    • Erstelle einen neuen API-Key und weise die zuvor erstellte API-Rolle zu.

    • Notiere sich den API-Key, da er für alle API-Anfragen benötigt wird.

Authentifizierung

Um auf die API zugreifen zu können, müssen Sie einen gültigen API-Key in den HTTP-Header Ihrer Anfragen einfügen. Der Authentifizierungsheader sollte wie folgt formatiert sein:

Authorization: Helpo <Dein_API_Schlüssel>

  • Helpo: Dies ist der spezifische Suffix, der verwendet wird, um anzuzeigen, dass der folgende Token für den API-Zugriff gültig ist.

  • <Dein_API_Schlüssel>: Ersetzen Sie dies durch den tatsächlich generierten API-Schlüssel, den Sie in der Verwaltung unter API-Keys erstellt haben.

Beispiel für eine API-Anfrage mit Authentifizierung:

Hier ist ein Beispiel für eine GET-Anfrage, die alle Kunden abruft und den Authentifizierungsheader verwendet:

GET /api/user/list/
Host: app.hello-perso.com
Authorization: Helpo <Dein_API_Schlüssel>
Content-Type: application/json

In diesem Beispiel wird der API-Schlüssel, der mit dem Suffix "Helpo" versehen ist, im Authorization-Header übermittelt. Dies ermöglicht der API, den Benutzer zu identifizieren und die erforderlichen Berechtigungen zu überprüfen.

Last updated