Wer kann diese Funktion nutzen?
Verfügbar aufEnterprise Plan.
Für Besitzer und Admins auf der Web-App zugänglich.
Um die Fax.Plus-API nutzen zu können, müssen Sie zuerst die Berechtigung für die API erteilen, um auf Ihr Konto zuzugreifen. Nach Abschluss der Autorisierung können Sie sich in Ihr Konto einloggen.
Es gibt zwei verschiedene Methoden für die Authentifizierung:
- Generieren und verwenden Sie persönliche Zugangs-Token.
- Verwende den OAuth 2.0 Flow.
Ein Persönliches Zugangs-Token kann als Authentifizierungsmethode verwendet werden, um sicher auf die Fax.Plus-API zuzugreifen. Dieses Token dient als digitale Unterschrift, um autorisierte Anfragen an unsere API zu stellen Aktivieren Sie Aktionen wie das Senden von Faxen und das Abrufen von Daten an Ihre Faxe.
Folgen Sie diesen Schritten, um ein neues Persönliches Zugangs-Token zu generieren:
- Melden Sie sich bei Ihrem Fax.Plus Konto an und gehen Sie zum ProfilAbschnitt auf Ihrem Dashboard.
- Finden Sie die Registerkarte für Integrationen.
- Unter FAX.PLUS APIfinden Sie den Eintrag für Persönliche Zugangs-Tokenund klicken Sie auf verwalten.
- Click on Generate Token and specify the token name, expiration date, and scopes.
- Stellen Sie sicher, dass Sie jetzt Ihre Persönliches Zugangs-Token kopieren, sonst können Sie es nicht mehr sehen.
Schritt 1: Einrichten des ersten Authentifizierungsablaufs
- Melden Sie sich bei Ihrem Fax.Plus Konto an und gehen Sie zum ProfilAbschnitt auf Ihrem Dashboard.
- Finden Sie die Registerkarte für Integrationen.
- Unter Fax.Plus APIklicken Sie auf Aktivieren Sieund sammeln Sie die folgenden Daten:
- Client-ID (beginnt mit APIK-)
- Kundengeheimnis
- URI umleiten (einer davon)
- Um den Prozess der Autorisierung der API für den Zugriff auf Ihr Konto zu starten, klicken Sie einfach auf den angegebenen Link in diesem Schritt mit einem Webbrowser. Dieser Link leitet Sie zu einer Eingabeaufforderung, wo Sie die nötigen Berechtigungen erteilen können: https://accounts.fax. lus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Sobald die Erlaubnis erteilt wurde, werden Sie zu der von Ihnen angegebenen URL weitergeleitet, begleitet von dem Autorisierungscode als URL-Parameter:
Schritt 2: Senden Sie eine HTTP-POST-Anfrage
Nachdem Sie den Zugriff erfolgreich autorisiert haben, können Sie mit einem HTTP POST fortfahren zu der folgenden URL: https://accounts.fax. lus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Stellen Sie sicher, dass die folgenden Header in Ihre Anfrage aufgenommen werden:
-
- Content-Type: application/x-www-form-urlencoded
- Autorisierung: Basic [base64-kodierter String von "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Sobald Sie fertig sind, erhalten Sie eine Antwort mit einem Zugangs-Token das für 1 Stunde gültig bleibt, sowie ein Aktualisierungstoken mit unbestimmter Gültigkeit.
Hinweis: Wenn Ihr Fax. lus Account hat Advanced Security Control aktiviert, das Aktualisierungs-Token bleibt gemäß den Sicherheitsbestimmungen für 30 Tage gültig. Dies bedeutet, dass Sie den Vorgang alle 30 Tage wiederholen müssen, um ein neues Aktualisierungstoken zu erhalten.
Schritt 3: Neues Zugangs-Token erhalten
Sobald Ihr Zugriffstoken abgelaufen ist, du kannst einen neuen durch eine HTTP-POST-Anfrage an die folgende URL mit deinem Aktualisierungs-Token erhalten: https://accounts. ax. lus/token?grant_type=refresh_token&refresh_token=[token].
Dieser Prozess erfordert die Aufnahme der folgenden Header:
-
- Content-Type: application/x-www-form-urlencoded
- Autorisierung: Basic [base64-kodierter String von "client_id:client_secret"]
Nachdem Sie das Zugriffstoken erhalten haben, benötigen alle nachfolgenden API-Aufrufe folgende Header:
-
- Autorisierung: Bär [Access Token]
- x-fax-clientid: [Client-ID]