Erstellen einer Benutzerdefinierten Integration in Robaws

Wenn Sie eine benutzerdefinierte Integration mit Robaws aufbauen möchten, wird HTTP Basic Authentication als empfohlene Authentifizierungsmethode verwendet.
Damit der API-Zugriff reibungslos funktioniert, müssen bestimmte Schritte unternommen werden, um einen Benutzer für die API-Nutzung zu erstellen und zu konfigurieren.

Für diejenigen, die Zugang zur Robaws-Umgebung des Kunden haben:

Wenn Sie Zugriff auf die Robaws-Umgebung des Kunden haben, können Sie selbst einen neuen API-Benutzer anlegen. Hier sind die empfohlenen Schritte:

Schritt 1: Erstellen eines neuen Benutzers in Robaws

- Gehen Sie in die Benutzerverwaltung des Kunden in Robaws.
- Erstellen Sie einen neuen Benutzer, der ausschließlich für die API-Integration verwendet wird.
- Achten Sie darauf, das Kästchen „Nur API“ zu markieren, damit keine zusätzlichen Kosten für den Benutzer anfallen.

Schritt 2: Rollen und Berechtigungen

- Erstellen Sie für diesen neuen API-Benutzer eine separate Rolle, die nur Zugriff auf die Module gewährt, die von der Integration benötigt werden. Dies ist eine empfohlene Best Practice, um die Sicherheit und den Datenschutz zu gewährleisten.

Beispiel:
Wenn Ihre API-Integration nur auf Projektdaten zugreifen muss, gewähren Sie diesem Benutzer ausschließlich Berechtigungen für das Modul „Projekte“.

Für Webentwickler oder API-Integratoren, die keinen Zugang zur Robaws-Umgebung des Kunden haben:

Wenn Sie nicht direkt auf die Robaws-Umgebung des Kunden zugreifen können, müssen Sie bestimmte Informationen vom Kunden anfordern. Dies ist besonders relevant für Webentwickler oder Integratoren, die im Auftrag des Kunden arbeiten.

Schritt 1: Informationen vom Kunden anfordern

Bitten Sie den Kunden, für Sie einen neuen API-Benutzer in ihrer Robaws-Umgebung zu erstellen. Sie sollten dabei auf die folgenden Punkte achten:

API-Benutzer anlegen: Der Kunde sollte in der Benutzerverwaltung einen neuen Benutzer anlegen, der für die API-Integration vorgesehen ist.
„Nur API“-Checkbox markieren: Informieren Sie den Kunden, das Kästchen „Nur API“ zu markieren, damit der Benutzer kostenlos bleibt.
Benutzerrollen definieren: Der Kunde sollte diesem Benutzer nur Zugriff auf die Module gewähren, die für die Integration notwendig sind (z.B. Projekte, Rechnungen, Artikel).

Schritt 2: Erhalten der API-Zugangsdaten

Sobald der Kunde den API-Benutzer erstellt hat, sollten Sie die folgenden Informationen erhalten:

- Benutzername (für den API-Zugang)
- Passwort (für den API-Zugang)

Mit diesen Zugangsdaten können Sie die HTTP Basic Authentication in Ihrer Integration verwenden.

Best Practices für die Integration

- Verwenden Sie immer eine separate Rolle für API-Benutzer, die nur Zugriff auf die wirklich notwendigen Module gewährt.
- Wenn möglich, beschränken Sie die Rechte und Funktionen des Benutzers, um die Sicherheit der Daten zu gewährleisten.

Falls Sie weitere Informationen oder Unterstützung bei der Einrichtung benötigen, wenden Sie sich an den Robaws-Support unter [email protected].

Aktualisiert am: 21/10/2024