Fax.Plus API を使用するには、まず API がお使いのアカウントにアクセスするための認可を付与する必要があります。認可プロセスが完了すると、アカウントにログインできるようになります。
認証には2つの異なる方法があります:
- パーソナルアクセストークンを生成して使用する。
- OAuth 2.0 フローを使用する。
パーソナルアクセストークンは、Fax.Plus APIに安全にアクセスするための認証方法として使用できます。このトークンはデジタル署名として機能し、ファックスの送信やファックスデータの取得などのアクションを可能にする、認証済みリクエストをAPIに対して行うことができます。
新しいパーソナルアクセストークンを生成するには、以下の手順に従ってください:
ステップ1: 初期認証フローを設定する
- Fax.Plusアカウントにログインし、ダッシュボードの設定 セクションに移動します。
- 連携タブを見つけます。
-
Fax.Plus APIの下にある有効化をクリックし、以下のデータを取得します:
- クライアントID(APIK-で始まる)
- クライアントシークレット
- リダイレクトURI(いずれか1つ)
- APIがアカウントにアクセスすることを承認するプロセスを開始するには、このステップで提供されているリンクをウェブブラウザでクリックするだけです。このリンクをクリックすると、必要な権限を付与できるプロンプトにリダイレクトされます: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
権限が付与されると、指定したURLに認証コードがURLパラメータとして付加された状態でリダイレクトされます:
ステップ2: HTTP POSTリクエストを送信する
アクセスの承認に成功したら、次のURLに対してHTTP POSTを実行できます: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
リクエストには必ず以下のヘッダーを含めてください:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
完了すると、1時間有効なアクセストークンと、無期限に有効なリフレッシュトークンを含むレスポンスを受け取ります。
注: Fax.Plusアカウントで高度なセキュリティ管理が有効になっている場合、セキュリティ規定に従い、リフレッシュトークンは30日間のみ有効です。これは、新しいリフレッシュトークンを取得するために、30日ごとにこのプロセスを繰り返す必要があることを意味します。
ステップ3: 新しいアクセストークンを取得する
アクセストークンの有効期限が切れたら、次のURLへのHTTP POSTリクエストを通じて、リフレッシュトークンを使用して新しいアクセストークンを取得できます: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token]。
このプロセスには、以下のヘッダーを含める必要があります:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
アクセストークンを取得した後、以降のすべてのAPI呼び出しには、以下のヘッダーが必要になります:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]