APIリクエストを認証するにはどうすればよいですか？

重要：Zendeskは認証方法としてのAPIトークンの提供を終了いたします。2026年7月28日以降、未使用のトークンは自動的に非アクティブになります。2027年4月30日までに、すべてのAPIトークンが機能しなくなります。「APIリクエストの認証方法としてのAPIトークンの提供終了に関するお知らせ」を参照してください。 

質問

Zendesk APIを使用してAPIリクエストを認証するにはどうすればよいですか？

回答

認証済みAPIリクエストを実行するには、認証済みのZendeskユーザーであることが必要です。APIリクエストを認証するには、メールアドレスとパスワード、メールアドレスとAPIトークン、またはOAuthアクセストークンでBasic認証を使用します。

すべての認証方法で、承認ヘッダーの設定が異なります。ペイロードまたはURLで送信された資格情報は処理されません。各オプションを以下に示します。

• APIトークン認証
• OAuthアクセストークン認証
• 承認ヘッダーを表示する

APIトークン認証

APIトークンを使用している場合、メールアドレスとAPIトークンを組み合わせて承認ヘッダーを生成します。メールアドレスとAPIトークンの組み合わせをBase-64エンコードされた文字列にフォーマットします。認証ヘッダーをフォーマットする方法の例については、次のコードブロックを参照してください。

Authorization: Basic {base-64-encoded email_address/token:api_token}

OAuthアクセストークン認証

OAuthを使用して認証を行う場合は、認証ヘッダーを次のようにフォーマットします。

Authorization: Bearer oauth_access_token

詳細については、「OAuth認証をアプリケーションで使用する」を参照してください。

承認ヘッダーを表示する

警告：ライブAPIトークン、本番APIトークン、OAuthアクセストークン、またはアカウントパスワードをサードパーティのリクエスト検査ツールや外部リクエストビンに送信しないでください。アクティブな資格情報を外部サービスに公開すると、セキュリティリスクが生じます。ヘッダーを外部でテストする場合は、ダミートークンまたはモックトークンを使用します。

アプリが送信するものを正確に確認するには、Pipedream（旧RequestBin）などのサードパーティページを使用します。OAuth認証を使用するWebhookによって生成されたヘッダーと比較します。Webhookをm. Pipedream.netのURLにポイントし「Webhookを追加」ページで、「Webhookをテスト」をクリックして、実際の動作を確認します。

リクエストがrequestb.inに届くと、次のように表示されます。

Authorization: Bearerの後ろの文字列は、「プログラムによるアクセス」にあるアカウント設定でRequestBinで提供されるAPIキーです。

Pythonを使用してリクエストを実行する場合、セッションヘッダーを以下のように設定します。

session = requests.Session()
session.headers = {'Content-Type': 'application/json', 'Authorization': 'Basic Basic_64_encoded_code'}

メモ：APIの使用状況ダッシュボードでAPIの使用状況を監視し、予想API制限を確認します。

詳細については、開発ドキュメントを参照してください：「セキュリティおよび認証」

翻訳に関する免責事項：この記事は、お客様の利便性のために自動翻訳ソフ トウェアによって翻訳されたものです。Zendeskでは、翻訳の正確さを期すために相応の努力を払っておりますが、翻訳の正確性につ いては保証いたしません。

翻訳された記事の内容の正確性に関して疑問が生じた場合は、正式版である英語の記事 を参照してください。