Wer kann diese Funktion nutzen?
Verfügbar im Enterprise-Tarif.
Zugänglich für Kontoinhaber und Admins in der Web-App.
Um die Fax.Plus API zu nutzen, müssen Sie zunächst der API die Berechtigung erteilen, auf Ihr Konto zuzugreifen. Nach Abschluss des Autorisierungsvorgangs können Sie sich in Ihrem Konto anmelden.
Es gibt zwei verschiedene Methoden zur Authentifizierung:
- Generieren und Verwenden von persönlichen Zugriffstoken.
- Verwendung des OAuth-2.0-Ablaufs.
Ein persönlicher Zugriffstoken kann als Authentifizierungsmethode verwendet werden, um sicher auf die Fax.Plus API zuzugreifen. Dieser Token dient als digitale Signatur und ermöglicht es Ihnen, autorisierte Anfragen an unsere API zu senden, wodurch Aktionen wie das Senden von Faxen und das Abrufen von Daten zu Ihren Faxen möglich werden.
Befolgen Sie diese Schritte, um einen neuen persönlichen Zugriffstoken zu erstellen:
- Melden Sie sich bei Ihrem Fax.Plus-Konto an und gehen Sie zum Bereich Einstellungen in Ihrem Dashboard.
- Suchen Sie die Registerkarte Integrationen.
- Suchen Sie unter Fax.Plus API den Eintrag für Persönliche Zugriffstoken und klicken Sie auf Verwalten.
- Klicken Sie auf Token erstellen und geben Sie den Tokennamen, das Ablaufdatum und die Berechtigungen (Scopes) an (sowohl „edit“ als auch „read“ als Berechtigungen für den Token).
- Stellen Sie sicher, dass Sie Ihren persönlichen Zugriffstoken jetzt kopieren, da Sie ihn danach nicht mehr einsehen können.
Schritt 1: Ersten Authentifizierungsablauf einrichten
- Melden Sie sich bei Ihrem Fax.Plus-Konto an und gehen Sie zum Bereich Einstellungen in Ihrem Dashboard.
- Suchen Sie die Registerkarte Integrationen.
- Klicken Sie unter Fax.Plus API auf Aktivieren und sammeln Sie die folgenden Daten:
- Client-ID (beginnt mit APIK-)
- Client-Secret
- Redirect-URI (eine davon)
- Um den Vorgang zur Autorisierung der API für den Zugriff auf Ihr Konto zu starten, klicken Sie einfach auf den in diesem Schritt bereitgestellten Link mit einem Webbrowser. Dieser Link leitet Sie zu einer Aufforderung weiter, bei der Sie die erforderlichen Berechtigungen erteilen können: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Sobald die Berechtigung erteilt wurde, werden Sie zu der von Ihnen angegebenen URL weitergeleitet, wobei der Autorisierungscode als URL-Parameter angefügt wird:
Schritt 2: HTTP-POST-Anfrage senden
Nachdem Sie den Zugriff erfolgreich autorisiert haben, können Sie einen HTTP-POST an die folgende URL durchführen: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Stellen Sie sicher, dass Sie folgende Header in Ihre Anfrage einbeziehen:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Nach Abschluss erhalten Sie eine Antwort mit einem Zugriffstoken, der 1 Stunde lang gültig ist, sowie einem Refresh-Token mit unbegrenzter Gültigkeit.
Hinweis: Wenn in Ihrem Fax.Plus-Konto Advanced Security Control aktiviert sind, bleibt der Refresh-Token gemäß den Sicherheitsvorschriften 30 Tage gültig. Das bedeutet, dass Sie den Vorgang alle 30 Tage wiederholen müssen, um einen neuen Refresh-Token zu erhalten.
Schritt 3: Neuen Zugriffstoken erhalten
Sobald Ihr Zugriffstoken abgelaufen ist, können Sie mithilfe Ihres Refresh-Tokens über eine HTTP-POST-Anfrage an die folgende URL einen neuen erhalten: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Für diesen Vorgang müssen folgende Header enthalten sein:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Nachdem Sie den Zugriffstoken erhalten haben, benötigen alle nachfolgenden API-Aufrufe die folgenden Header:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]