個人用アクセストークンを使用してFax.Plus APIの詳細なアクセスを作成します

Personal Access Tokens(PATs)は、Fax.Plus APIへの安全で詳細なアクセスを提供します。 このガイドでは、統合のニーズに適した権限を持つトークンの作成と管理のプロセスについて説明します。

パーソナルアクセストークンの作成

アクセストークンの生成

1. Log in to your Fax.Plus dashboard at app.fax.plus
2. プロフィール > 統合 > パーソナルアクセストークン
3. 「新しいトークンを生成」をクリックします

トークンの設定

新しいトークンを生成するときは、次のように設定する必要があります。

1. トークン名: トークンの目的を識別する説明名を選択してください
2. 有効期限: カスタムの有効期限を設定します (推奨日: 90 日)

利用可能なスコープ

トークンのアクセス権限を定義するには、次のスコープを1つ以上選択してください:

一般的なアクセス

• fax:all:read- すべてのFAX関連の操作への読み取り専用アクセス
  • ファックス、ユーザー、メンバー、番号を表示
• fax:all:edit - すべてのFAX関連の操作にフルアクセス
  • ファックス、ユーザー、メンバー、ウェブフック、および番号を管理する

Webhook管理

• fax:webhook:read- Webhookの設定を表示

• fax:webhook:edit- 完全なWebhook管理機能

FAX操作

• fax:fax:read- FAXを表示するためのアクセス
  • 送信トレイリスト、FAXファイル、レポートを表示
• fax:fax:edit- 完全な fax 管理権限 
  • 送信トレイ、ファイル、FAXの詳細を管理する

ユーザー管理

• fax:use:read- 現在のユーザー詳細を表示(PATオーナー)
• fax:user:edit- 現在のユーザー詳細を更新

ショップの機能

• fax:shop:read- Fax番号を参照し、残高クレジットを確認する
• fax:shop:edit- 購入番号

メンバーアクセス

• fax:member:read- アカウントとメンバーの詳細を表示
• fax:member:edit- メンバー情報の管理

数値管理

• fax:numbers:read- Fax番号の一覧と表示
• fax:numbers:edit- Full fax number management

セキュリティのベストプラクティス

1. 最低特権の原則
   • 統合に必要なスコープのみを付与する
   • 書き込みアクセスが不要な場合に読み取り専用のスコープを使用する
2. トークンの回転
   • トークンを90日ごとに回転
   • トークンの回転にリマインダーを設定する
   • 古いトークンが期限切れになる前に新しいトークンを作成して継続的なサービスを確保する
3. トークン管理
   • トークンを安全に保ち、共有することはありません
   • 侵害された場合、すぐにトークンを取り消します
   • アプリケーションの設定でトークンを安全に保管する

実装のヒント

1. 範囲の選択
   • 読み取り専用の操作には、 *:readスコープを使用します
   • 完全な管理のために、 *:editスコープを使用してください
   • fax:all:readまたは fax:all:editを使用して幅広いアクセスのニーズを満たすことを検討してください
2. テスト
   • 最小限のスコープで最初に統合をテストする
   • 必要に応じて徐々にスコープを追加
   • アプリケーションでトークンの有効期限の処理を確認する

トラブルシューティング

アクセスの問題が発生した場合:

1. トークンが期限切れでないことを確認してください
2. すべての必須スコープを選択していることを確認します
3. トークンが取り消されたかどうかを確認する
4. API リクエストでトークンを正しく使用していることを確認してください