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認証の使用」

承認ヘッダーを表示するには

アプリから送信された内容を正確に確認する場合は、「リクエストビン」などのサードパーティのページを使用します。Basic認証が使用されるHTTPターゲットによって生成されているヘッダーと、自分のヘッダーを比較します。HTTPターゲットを同じrequestb.inページに指定し、「ターゲットのテスト」を選択して、次のアクションを確認してください：

requestb.inにヒットしたら、以下のように表示されます：

「Authorization：」の後の文字列Basic"＝dXNlckBlbWFpbC5jb206b3BlbnNlc2FtZQ＝＝

これは、base64でエンコードされたユーザー名/パスワードのバージョンです。このバージョンを手動でデコードするには、Base64Decodeなどのサードパーティのページにアクセスします。 文字列を上のボックスに貼り付け、「デコード」をクリックします。

Pythonを使用してリクエストを実行している場合は、次のようにセッションヘッダーを設定することが可能です。

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

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