Wie kan deze functie gebruiken?
Beschikbaar met het Enterprise abonnement.
Toegankelijk voor eigenaren en beheerders in de webapp.
Om de Fax.Plus API te gebruiken, moet u eerst autorisatie verlenen aan de API om toegang te krijgen tot uw account. Nadat u het autorisatieproces hebt voltooid, kunt u inloggen op uw account.
Er zijn twee verschillende methoden voor authenticatie:
- Persoonlijke toegangstokens genereren en gebruiken.
- De OAuth 2.0-flow gebruiken.
Een persoonlijk toegangstoken kan worden gebruikt als authenticatiemethode om veilig toegang te krijgen tot de Fax.Plus API. Dit token fungeert als een digitale handtekening, waarmee u geautoriseerde verzoeken naar onze API kunt doen, zoals het verzenden van faxen en het ophalen van gegevens van uw faxen.
Volg deze stappen om een nieuw persoonlijk toegangstoken te genereren:
- Log in op uw Fax.Plus-account en ga naar het gedeelte Instellingen op uw dashboard.
- Zoek het tabblad Integraties.
- Zoek onder Fax.Plus API het item Persoonlijke toegangstokens en klik op Beheren.
- Klik op Token genereren en geef de tokennaam, de vervaldatum en de machtigingen op (zowel bewerken als lezen als machtigingen voor het token).
- Zorg ervoor dat u uw persoonlijk toegangstoken nu kopieert, anders kunt u het niet opnieuw bekijken.
Stap 1: De eerste authenticatieflow instellen
- Log in op uw Fax.Plus-account en ga naar het gedeelte Instellingen op uw dashboard.
- Zoek het tabblad Integraties.
- Klik onder Fax.Plus API op Activeren en verzamel de volgende gegevens:
- Client-ID (begint met APIK-)
- Clientgeheim
- Redirect-URI (een van de URI's)
- Om het proces te starten waarmee u de API toegang tot uw account verleent, klikt u met een webbrowser op de link in deze stap. Deze link leidt u naar een scherm waar u de benodigde machtigingen kunt verlenen: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Zodra toestemming is verleend, wordt u doorgestuurd naar de URL die u hebt opgegeven, vergezeld van de autorisatiecode als URL-parameter:
Stap 2: Een HTTP-POST-verzoek verzenden
Nadat u de toegang met succes hebt geautoriseerd, kunt u een HTTP POST uitvoeren naar de volgende URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Zorg ervoor dat u de volgende headers in uw verzoek opneemt:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Nadat dit is voltooid, ontvangt u een antwoord met een toegangstoken, dat 1 uur geldig blijft, en een vernieuwingstoken met onbeperkte geldigheid.
Opmerking: Als voor uw Fax.Plus-account Advanced Security Control is geactiveerd, blijft het vernieuwingstoken 30 dagen geldig, in overeenstemming met de beveiligingsvoorschriften. Dit betekent dat u het proces elke 30 dagen moet herhalen om een nieuw vernieuwingstoken te verkrijgen.
Stap 3: Een nieuw toegangstoken ophalen
Zodra uw toegangstoken is verlopen, kunt u met uw vernieuwingstoken een nieuw token ophalen via een HTTP-POST-verzoek naar de volgende URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Voor dit proces moeten de volgende headers worden opgenomen:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Nadat u het toegangstoken hebt verkregen, vereisen alle volgende API-aanroepen de volgende headers:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]