Qui peut utiliser cette fonctionnalité\u00a0?
Disponible avec le plan Enterprise.
Accessible aux propriétaires et administrateurs sur l'application Web.
Pour utiliser l'API Fax.Plus, vous devez d'abord autoriser l'API à accéder à votre compte. Une fois le processus d'autorisation terminé, vous pouvez vous connecter à votre compte.
Il existe deux méthodes différentes pour l'authentification\u00a0:
- Générer et utiliser des jetons d'accès personnels.
- Utiliser le flux OAuth 2.0.
Un Personal Access Token peut être utilisé comme méthode d'authentification pour accéder à l'API Fax.Plus de façon sécurisée. Ce jeton fait office de signature numérique, vous permettant d'envoyer des requêtes autorisées à notre API, ce qui rend possible des actions telles que l'envoi de fax et la récupération de données liées à vos fax.
Suivez ces étapes pour générer un nouveau Personal Access Token :
- Connectez-vous à votre compte Fax.Plus, puis accédez à la section Settings de votre tableau de bord.
- Repérez l'onglet Integrations.
- Sous Fax.Plus API, repérez l'élément Personal Access Tokens, puis cliquez sur Manage.
- Cliquez sur Generate Token et indiquez le nom du jeton, la date d'expiration, ainsi que les scopes (attribuez au jeton les autorisations edit et read).
- Veillez à Copier votre Personal Access Token dès maintenant, sinon vous ne pourrez plus le consulter par la suite.
Étape 1 : Configurer le flux d'authentification initial
- Connectez-vous à votre compte Fax.Plus, puis accédez à la section Settings de votre tableau de bord.
- Repérez l'onglet Integrations.
- Sous Fax.Plus API, cliquez sur Activate, puis récupérez les informations suivantes :
- Client ID (commence par APIK-)
- Client secret
- Redirect URI (un seul suffit)
- Pour lancer le processus d'autorisation permettant à l'API d'accéder à votre compte, cliquez simplement sur le lien fourni à 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.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Une fois l'autorisation accordée, vous serez redirigé vers l'URL que vous avez spécifiée, accompagnée du code d'autorisation en tant que paramètre d'URL :
Étape 2 : Envoyer une requête HTTP POST
Une fois l'accès autorisé avec succès, vous pouvez procéder à une requête HTTP POST vers l'URL suivante : https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Veillez à inclure les en-têtes suivants dans votre requête :
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Une fois cette étape terminée, vous recevrez une réponse contenant un access token, valable 1 heure, ainsi qu'un refresh token à validité indéfinie.
Remarque : si votre compte Fax.Plus a l'Advanced Security Control activé, le refresh token reste valable 30 jours, conformément aux règles de sécurité. Cela signifie que vous devrez répéter le processus tous les 30 jours pour obtenir un nouveau refresh token.
Étape 3 : Obtenir un nouvel access token
Une fois votre access token expiré, vous pouvez en obtenir un nouveau grâce à votre refresh token, via une requête HTTP POST vers l'URL suivante : https://accounts.fax.plus/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
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Après avoir obtenu l'access token, tous les appels API suivants nécessiteront les en-têtes suivants :
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]