本文へスキップ

HTTPヘッダー

このセクションでは、APIがリクエストから受け付けるHTTPヘッダについて説明する。

コンテンツタイプ

すべてのリクエストは、content-type HTTPヘッダを含んでいなければなりません。

受け入れられるコンテンツ・タイプ

基本フォーマットコンテンツタイプコンテンツタイプ
JSONapplication/jsontext/jsonは現在認められていないコンテンツタイプです。
フォームデータマルチパート/フォームデータバリエーションをアップロードする場合のみ使用

コンテンツ・タイプ・エラー

レスポンスコード備考
400コンテンツタイプは理解できたが、デコードできなかった。詳細はレスポンス・ボディに表示されます。
415コンテンツタイプがない、またはサポートされていない

*注***:Content-type ヘッダに問題がある場合、レスポンスの Content-Type は API のデフォルトフォーマット、現在は application/json になります。



*注***:すべてのレスポンスは、リクエストのcontent-typeが有効であれば、受信したリクエストと同じcontent-typeで送信される。


認可

このヘッダはオプションであり、現在のユーザが制限されたAPIリソースにアクセスできるようにするために、現在のユーザの認証の詳細をAPIに提供するために使用される。トークンはLogin APIで取得できる。ヘッダの例は以下のとおり:


Authorization: Bearer 45267dbe480c8c7d799c62ccad92cb44f67ab086

Authorizationヘッダーは、スペース1個で区切られた2つの部分からなる文字列を受 け取る。最初の部分はトークンタイプで、2つ目はアクセストークンそのものである。

認証エラー

レスポンスコード備考
400不正な認可ヘッダーが提供された
401認証ヘッダがないか、トークンが無効または期限切れである。

認証トークン・タイプの選択

失敗した場合、応答ヘッダーは、アクセスに必要なトークンタイプを示すWWW-Authenticateヘッダーを含む。