Fax.Plus APIは、チームメンバーがチームの階層構造内であなたより下位の位置にある場合、そのメンバーの情報や受信したfaxファイルをシームレスに収集するための強力なソリューションを提供します。
注:初期認証プロセスを完了し、APIに正常にログインしていることを確認してください。追加の手順については、こちらのガイドをご覧ください。
先に進む前に、対象のチームメンバーが、チームの階層構造においてAPIユーザーより下位の役職に就いていることを確認してください。以下のスクリーンショットのとおり、Test Adminのアカウントは問題なくAPIに接続でき、Test Memberの重要な情報やfaxファイルにアクセスできます。
すべての法人メンバーの一覧を取得するには、次のURLにHTTP GETリクエストを送信します:https://restapi.fax.plus/v3/accounts/。
リクエストには次のヘッダーを必ず含めてください:
-
Content-Type:
multipart/form-data -
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
取得したデータには、UID(ユーザーID)をはじめとするメンバーの詳細情報が含まれており、確認できます。
メンバーのユーザーIDを取得できたら、そのメンバーの受信したfaxに簡単にアクセスできます。次のURLにHTTP GETリクエストを送信するだけです:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox。
リクエストには次のヘッダーを必ず含めてください:
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
fax IDはレスポンスから取得できます。
注:「fax_received」イベント専用のwebhookを設定することをご検討ください。イベントのfax IDに加えて、さらに詳しい情報も受け取れます。詳細については、こちらのガイドをご覧ください。
faxのファイルを取得するには、次のURLにHTTP GETリクエストを送信します:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf。
リクエストには次のヘッダーを必ず含めてください:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]