Lokalisierung läuft: Einige Teile des Inhalts werden möglicherweise noch auf Englisch angezeigt, während wir die Übersetzung abschließen.

Einführung in Integrationsqualifikationen

Prev Next

Dies ist nur für Kontomanager mit Zugriff auf Kontoeinstellungen verfügbar. Lesen Sie hier mehr über Zugriffsrechte.

Anfang

Um mit der Quinyx API zu beginnen, gibt es ein paar Dinge, die Sie wissen müssen.

Das für die Autorisierung der REST-APIs verwendete Framework ist Oauth2. Detailliertere Informationen finden Sie hier https://oauth.net/2/

Qualifikationen

Der grundlegende Ablauf der Authentifizierung besteht darin, dass einem Benutzer eine Reihe von Zugangsdaten zugewiesen wird, die mit einer UUID identifiziert werden:

  • uuid – Dies ist eine Identifikatorin für die Menge der Zugangsdaten. Diese wird bei Bedarf in der Kommunikation mit dem Quinyx-Support verwendet.

  • Client-ID – bewahren Sie diese an einem sicheren Ort auf. Kann geteilt werden, meist als Benutzername in Anwendungen wie Postman oder ähnlichen Anwendungen.

  • Client-Geheimnis – muss SEHR vertraulich gehalten werden, das ist das Passwort und in Kombination mit der Client-ID erhält der Besitzer Zugriff auf die definierten Scopes.

Anwendungsbereiche und Berechtigungen

Umfang

Scope bestimmt, auf welche "Gruppe" von Funktionen Sie über die API Zugriff haben.

Als Beispiel

  • Vorhersage

  • Vorhersage

  • Tags

  • Verfügbarkeit

  • Öffnungszeiten

  • Gruppen

  • Kartierung

  • Abwesenheit

  • Statistiken

  • Kollaborationsgruppen

  • KI-Algorithmen

  • Personen

  • Gehaltspläne

  • Vereinbarung

  • Mitarbeiter

  • Schichten

Berechtigungen

Die Berechtigungen bestimmen, was du mit der Funktionalität machen kannst, auf die du Zugriff hast.

Lesen – GET

Hinzufügen – POSTEN

Schreiben – PUT, PATCH

Löschen – LÖSCHEN

Erstelle Zugangsdaten

  1. Klicken Sie auf Kontoeinstellungen.

  2. Unter Zugriffsrechte klicken Sie auf Integrationszugangsdaten. Wenn Zugangsdaten vorhanden sind, werden sie hier angezeigt, und Sie können Namen und Beschreibungen der bestehenden bearbeiten. Sie können auch sehen, welche Umfangsbereiche und Berechtigungen für jede Zugangsdatengruppe festgelegt sind.

  3. Um einen neuen Satz von Zugangsdaten zu erstellen, klicken Sie auf Zugangsdaten generieren.

    Name

    (Pflicht)

    Schreiben Sie den Namen dieser Berechtigungsdaten ein. Dies kann später noch bearbeitet werden, ist aber ein Pflichtfeld.

    Beschreibung

    (Pflicht)

    Schreiben Sie eine Beschreibung für diese Zugangsliste. Diese kann später bearbeitet werden, ist aber ein verpflichtendes Feld.

    Version

    Wählen Sie zwischen den Teleskopen von Version 2 und Version 3 .

    Anwendungsbereiche und Berechtigungen

    Wähle die Scopes und Berechtigungen, die du für die Zugangsdaten haben möchtest

    Lesen - HOLEN, Hinzufügen - POSTEN, Schreiben - SETZEN, PATCHEN, Löschen - LÖSCHEN

  4. Wenn Sie auf Speichern klicken, wird Ihnen das Geheimnis angezeigt. Dies sollte entsprechend gespeichert und behandelt werden, da es sehr sensible Informationen sind. Sie werden diese Informationen nicht mehr einsehen können.

  5. Speichere das Client-Geheimnis sicher an einem Ort deiner Wahl und klicke erst dann auf Fertig. Du kannst dein Client-Geheimnis nicht erneut anzeigen. Du kannst nur die Client-ID und UUID der Zugangsdaten einsehen.

Bearbeitungsnachweise

Du kannst nur den Namen und die Beschreibung der REST-API-Zugangsdaten bearbeiten. Wenn du die Scopes und/oder Berechtigungen ändern musst, musst du neue erstellen und dann die alten löschen.

Zugangsdaten löschen

Du kannst Zugangsdaten löschen, aber stelle sicher, dass sie nicht verwendet werden, bevor du das tust.

Hier findest du Links zur REST API-Dokumentation.