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

質問

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

回答

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

それぞれの認証方法で、承認ヘッダーの設定が異なります。ペイロードまたはURLで送信された資格情報は処理されません。

この記事では、次のトピックについて説明します。

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

Basic認証

Basic認証を使用している場合は、メールアドレスとパスワードを組み合わせて承認ヘッダーを生成できます。メールアドレスとパスワードの組み合わせは、Base-64でエンコードされた文字列でなければなりません。以下のように認証ヘッダーをフォーマットします。

Authorization: Basic email_address:password

APIトークン

APIトークンを使用している場合、メールアドレスとAPIトークンを組み合わせて承認ヘッダーを生成します。メールアドレスとAPIトークンの組み合わせは、Base-64でエンコードされた文字列でなければなりません。以下のように認証ヘッダーをフォーマットします。

Authorization: Basic email_address/token:api_token

OAuthアクセストークン

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

Authorization: Bearer oauth_access_token

詳細については、次の記事を参照してください： 「アプリでのOAuth認証の使用」

承認ヘッダーを表示する

アプリから送信された内容を正確に確認する場合は、Request Bin などのサードパーティのページを使用します。OAuth認証を使用するWebhookにより生成されるヘッダーと、自分のヘッダーを比較します。Webhookを requestb.in の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'}

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