Detaillierte Zugriffsrechte für die Fax.Plus API mit Personal Access Tokens einrichten

Personal Access Tokens (PATs) ermöglichen einen sicheren und fein abgestuften Zugriff auf die Fax.Plus API. In dieser Anleitung erfahren Sie, wie Sie Tokens mit den passenden Berechtigungen für Ihre Integration erstellen und verwalten.

Personal Access Token erstellen

Zugriffstoken generieren

1. Melden Sie sich in Ihrem Fax.Plus-Dashboard unter app.fax.plus an
2. Gehen Sie zu Einstellungen > Integrationen > Personal Access Tokens
3. Klicken Sie auf „Neues Token generieren“

Token-Konfiguration

Beim Generieren eines neuen Tokens müssen Sie Folgendes konfigurieren:

1. Token-Name: Wählen Sie einen aussagekräftigen Namen, der den Zweck des Tokens beschreibt
2. Ablaufdatum: Legen Sie ein individuelles Ablaufdatum fest (empfohlen: 90 Tage)

Verfügbare Scopes

Wählen Sie einen oder mehrere der folgenden Scopes aus, um die Zugriffsberechtigungen des Tokens festzulegen:

Allgemeiner Zugriff

• fax:all:read

  - Schreibgeschützter Zugriff auf alle Fax-bezogenen Vorgänge

  • Faxe, Benutzer, Mitglieder und Nummern anzeigen
• fax:all:edit

   - Vollzugriff auf alle Fax-bezogenen Vorgänge

  • Faxe, Benutzer, Mitglieder, Webhooks und Nummern verwalten

Webhook-Verwaltung

• fax:webhook:read- Webhook-Konfigurationen anzeigen

• fax:webhook:edit- Vollständige Webhook-Verwaltungsfunktionen

Fax-Vorgänge

• fax:fax:read

  - Zugriff zum Anzeigen von Faxen

  • Postausgangslisten, Fax-Dateien und Berichte anzeigen
• fax:fax:edit

  - Vollständige Berechtigungen zur Fax-Verwaltung 

  • Postausgang, Dateien und Fax-Details verwalten

Benutzerverwaltung

• fax:use:read

  - Details des aktuellen Benutzers (PAT-Inhaber) anzeigen

• fax:user:edit

   - Details des aktuellen Benutzers aktualisieren

Shop-Funktionen

• fax:shop:read

  - Fax-Nummern durchsuchen und Guthaben prüfen

• fax:shop:edit

  - Nummern kaufen

Mitgliederzugriff

• fax:member:read

  - Konto- und Mitgliederdetails anzeigen

• fax:member:edit

  - Mitgliederinformationen verwalten

Nummernverwaltung

• fax:numbers:read

   - Fax-Nummern auflisten und anzeigen

• fax:numbers:edit

  - Vollständige Verwaltung der Fax-Nummern

Bewährte Sicherheitspraktiken

1. Prinzip der geringsten Rechte
   • Erteilen Sie nur Scopes, die für Ihre Integration unbedingt erforderlich sind
   • Verwenden Sie schreibgeschützte Scopes, wenn kein Schreibzugriff erforderlich ist
2. Token-Rotation
   • Rotieren Sie Tokens alle 90 Tage
   • Richten Sie eine Erinnerung für die Token-Rotation ein
   • Erstellen Sie neue Tokens, bevor die alten ablaufen, um einen unterbrechungsfreien Betrieb sicherzustellen
3. Token-Verwaltung
   • Bewahren Sie Tokens sicher auf und geben Sie sie niemals weiter
   • Widerrufen Sie Tokens sofort, wenn sie kompromittiert wurden
   • Speichern Sie Tokens sicher in der Konfiguration Ihrer Anwendung

Tipps zur Implementierung

1. Auswahl der Scopes

   • Verwenden Sie für schreibgeschützte Vorgänge 

     *:read

     -Scopes

   • Verwenden Sie für die vollständige Verwaltung 

     *:edit

     -Scopes

   • Erwägen Sie die Verwendung von 

     fax:all:read

     oder 

     fax:all:edit

      bei umfassendem Zugriffsbedarf

2. Testen
   • Testen Sie Ihre Integration zunächst mit minimalen Scopes
   • Fügen Sie bei Bedarf schrittweise weitere Scopes hinzu
   • Überprüfen Sie in Ihrer Anwendung den Umgang mit dem Ablauf von Tokens

Fehlerbehebung

Falls Zugriffsprobleme auftreten:

1. Prüfen Sie, ob das Token abgelaufen ist
2. Vergewissern Sie sich, dass Sie alle erforderlichen Scopes ausgewählt haben
3. Prüfen Sie, ob das Token widerrufen wurde
4. Stellen Sie sicher, dass Sie das Token in API-Anfragen korrekt verwenden

Personal Access Tokens werden derzeit pro Benutzer verwaltet – jedes Teammitglied erstellt und widerruft seine eigenen Tokens unter Einstellungen > Integrationen > Personal Access Tokens. Derzeit gibt es keine Self-Service-Administratorfunktion, um PATs anderer Mitglieder des Kontos zu widerrufen oder zu deaktivieren.