Qui peut utiliser cette fonctionnalité ?
Available on Enterprise plan.
Accessible aux propriétaires et administrateurs de l'application Web.
Pour utiliser l'API Fax.Plus, vous devez d'abord autoriser l'API à accéder à votre compte. Après avoir terminé le processus d'autorisation, vous pouvez vous connecter à votre compte.
Il y a deux méthodes différentes pour l'authentification :
- Générer et utiliser des jetons d'accès personnels.
- Utilisez le flux OAuth 2.0.
A Personal Access Token can be used as an authentication method to access the Fax.Plus API securely. Ce jeton sert de signature numérique, vous permettant de faire des requêtes autorisées à notre API, activer des actions telles que l'envoi de télécopies et la récupération des données à vos télécopies.
Suivez ces étapes pour générer un nouveau jeton d'accès personnel :
- Connectez-vous à votre compte Fax.Plus et allez dans la section Profilde votre tableau de bord.
- Trouvez l'onglet Intégrations.
- Sous API FAX.PLUS, trouvez l'élément pour Jetons d'accès personnels, et cliquez sur Gérer.
- Cliquer sur Générer le jetonet spécifier le nom de jeton , date d'expiration, et les portées.
- Assurez-vous de Copiez votre jeton d'accès personnel maintenant, sinon vous ne pourrez plus le voir.
Étape 1 : Mettre en place le flux initial d'authentification
- Connectez-vous à votre compte Fax.Plus et allez dans la section Profilde votre tableau de bord.
- Trouvez l'onglet Intégrations.
- Sous API Fax.Plus, cliquez sur Activeret collectez les données suivantes :
- ID du client (commence par APIK-)
- Secret du client
- URI de redirection (l'un d'eux)
- Pour lancer le processus d'autorisation de l'API pour accéder à votre compte, cliquez simplement sur le lien fourni dans cette étape à l'aide d'un navigateur Web. Ce lien vous redirigera vers une invite où vous pourrez accorder les autorisations nécessaires : https://accounts.fax. lus/login?response_type=code&client_id=[ID client]&redirect_uri=[URI de redirection]&scope=all
-
Une fois la permission accordée, vous serez dirigé vers l'URL que vous avez spécifiée, accompagnée du code d'autorisation comme paramètre d'URL :
Étape 2 : Envoyer une requête HTTP POST
Une fois que vous avez réussi à accéder à un accès autorisé, vous pouvez effectuer un POST HTTP à l'URL suivante : https://accounts.fax. lus/token?grant_type=authorization_code&client_id=[ID client]&code=[code d'autorisation]&redirect_uri=[URI de redirection].
Assurez-vous d'inclure les en-têtes suivants dans votre requête :
-
- Content-Type: application/x-www-form-urlencoded
- Autorisation : Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Une fois terminé, vous recevrez une réponse contenant un jeton d'accès, qui reste valide pendant 1 heure, ainsi qu'un jeton de rafraîchissement avec une validité indéfinie.
Note: If your Fax.Plus account has Advanced Security Control activated, the refresh token remains valid for 30 days in accordance with security regulations. Cela implique que vous devrez répéter le processus tous les 30 jours pour obtenir un jeton de rafraîchissement.
Étape 3 : Obtenir un nouveau jeton d'accès
Une fois que votre jeton d'accès a expiré, vous pouvez en obtenir un nouveau en utilisant votre jeton de rafraîchissement via une requête HTTP POST à l'URL suivante : https://accounts. ax. lus/token?grant_type=refresh_token&refresh_token=[refresh token].
Ce processus nécessite l'inclusion des en-têtes suivants :
-
- Content-Type: application/x-www-form-urlencoded
- Autorisation : Basic [base64-encoded string of "client_id:client_secret"]
Après avoir obtenu le jeton d'accès, tous les appels suivants à l'API nécessiteront les en-têtes suivants :
-
- Autorisation : Bearer [jeton d'accès]
- x-fax-clientid: [ID du client]