API

Die RAGAI API ermöglicht es, Bots über einen eingebetteten iFrame anzusprechen und zu steuern. Detaillierte Implementierungsbeispiele sind in der RAGAI API Dokumentation zu finden.

---

Access Token

Mit Access Tokens können Dritt-Systeme über die API mit dem System kommunizieren. Eine detaillierte Beschreibung der Schnittstellen ist unter Swagger verfügbar.

Erstellen eines Access Tokens

Ein Access Token kann erstellt werden, indem folgende Parameter gesetzt werden:

1. Name des Tokens – Eine eindeutige Bezeichnung für den Token.
2. Scopes (Berechtigungen) – Definiert, welche Aktionen der Token ausführen darf:
   • userlist:read – Abfragen der Nutzerfreigaben
   • userlist:write – Ändern der Nutzerfreigaben
   • userlistorg:read – Abfragen der Nutzerfreigaben der gesamten Organisation
3. Ablaufdatum – Die Gültigkeitsdauer des Tokens kann festgelegt werden (z. B. 7 Tage).

Nach der Generierung eines Tokens sollte dieser unbedingt kopiert werden, da er später nicht mehr eingesehen werden kann.

---

Access Token Übersicht

Hier werden alle bereits erstellten Access Tokens angezeigt, inklusive:

• Name des Tokens
• Berechtigungen (Scopes)
• Ablaufdatum
• Status (Verwendung)

Aktionen

• Neuen Token generieren – Erstellt einen neuen API-Zugriffstoken.
• Löschen – Entfernt einen bestehenden Token unwiderruflich.

---

Sicherheitshinweise

• Speicherung: Ein Access Token wird nur einmalig angezeigt und kann später nicht erneut eingesehen werden.
• Verwendung: Tokens sollten sicher gespeichert und nicht mit Dritten geteilt werden.
• Löschung: Falls ein Token kompromittiert wurde, sollte er umgehend gelöscht und neu generiert werden.