L'API Fax.Plus offre une solution puissante pour récupérer facilement les informations et les fax reçus par les membres de votre équipe, à condition qu'ils occupent une position inférieure dans la structure hiérarchique de l'équipe.
Remarque : assurez-vous d'avoir terminé la procédure d'authentification initiale et de vous être connecté à l'API. Pour plus d'instructions, consultez notre guide ici.
Avant de poursuivre, vérifiez que le membre d'équipe concerné occupe une position subordonnée à celle de l'utilisateur de l'API dans la hiérarchie de l'équipe. Comme le montrent les captures d'écran ci-dessous, le compte du Test Admin peut se connecter sans difficulté à l'API et accéder ainsi à des informations essentielles et aux fichiers de fax appartenant au Test Member.
Pour obtenir la liste de tous les membres de l'entreprise, envoyez une requête HTTP GET à l'URL suivante : https://restapi.fax.plus/v3/accounts/.
Veillez à inclure les en-têtes suivants dans votre requête :
-
Content-Type:
multipart/form-data -
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
Vous pouvez alors consulter les informations du membre, y compris son UID (identifiant utilisateur), qui figure dans les données récupérées.
Une fois l'identifiant utilisateur du membre obtenu, l'accès à ses fax reçus est très simple. Pour cela, envoyez simplement une requête HTTP GET à l'URL suivante :
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.
Veillez à inclure les en-têtes suivants dans votre requête :
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
L'identifiant du fax figure dans la réponse.
Remarque : vous pouvez configurer un webhook dédié à l'événement « fax_received ». Il vous fournira non seulement l'identifiant du fax associé à l'événement, mais aussi des informations complémentaires. Pour plus d'informations, reportez-vous à notre guide ici.
Pour récupérer les fichiers du fax, vous pouvez envoyer une requête HTTP GET à l'URL suivante :
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.
Veillez à inclure les en-têtes suivants dans votre requête :
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]