Personal Access Tokenを使用してFax.Plus APIへの詳細なアクセス権を作成する

Personal Access Token(PAT)は、Fax.Plus APIへの安全で詳細なアクセスを提供します。このガイドでは、統合ニーズに適した権限を持つトークンを作成および管理する手順を説明します。

Personal Access Tokenの作成

アクセストークンの生成

1. app.fax.plusでFax.Plusダッシュボードにログインします
2. 「設定」>「統合」>「Personal Access Tokens」に移動します
3. 「新しいトークンを生成」をクリックします

トークンの設定

新しいトークンを生成する際には、以下を設定する必要があります:

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

利用可能なスコープ

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

一般アクセス

• fax:all:read- すべてのfax関連操作への読み取り専用アクセス
  • fax、ユーザー、メンバー、電話番号を表示
• fax:all:edit - すべてのfax関連操作への完全アクセス
  • fax、ユーザー、メンバー、Webhook、電話番号を管理

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- fax番号の完全な管理

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

1. 最小権限の原則
   • 統合に絶対に必要なスコープのみを付与してください
   • 書き込みアクセスが不要な場合は読み取り専用スコープを使用してください
2. トークンのローテーション
   • 90日ごとにトークンをローテーションしてください
   • トークンのローテーションのためのリマインダーを設定してください
   • 継続的なサービスを確保するため、古いトークンが失効する前に新しいトークンを作成してください
3. トークンの管理
   • トークンは安全に保管し、決して共有しないでください
   • 漏洩した場合は直ちにトークンを取り消してください
   • トークンはアプリケーションの設定内に安全に保管してください

実装のヒント

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

トラブルシューティング

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

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