要求に特定の HTTP ヘッダーを追加する必要があるケースがあります。例えば、API の中には、カスタム・ヘッダー・フィールド内で利用する API のバージョン番号 (例: API-VERSION) が必須のものがあります。Authorization などの標準 HTTP ヘッダーを追加する必要がある場合もあるでしょう。
Content-Length と Content-Type は、要求本文に追加されたコンテンツを元に自動的に設定されることに注意してください (要求本文へのコンテンツ追加についてはこの次に説明されます)。
要求にヘッダーを追加するには、Options オブジェクトの AddHeader メソッドを使用します。
#Request.Options.AddHeader Name('API-VERSION') Value('2.0')
認証ヘッダーに関しては、便宜上 2 つのメソッドが提供されています (これらは基本的に AddHeader を手動で起動させるためのショートカットに過ぎません)。
- AddBasicAuthorization
- AddBearerAuthorization
基本認証
基本認証は、承認やリソースの権限承認にユーザー名とパスワードを利用します。API がこの承認メソッドを使用することは一般的ではありません。ほとんどのサービスでは API キーまたはアクセス・トークンが使用されます。
以下は使用例です。
#Request.Options.AddBasicAuthorization UserName('my-username') Password('my-password')
ベアラー・トークンを使った認証
ベアラー・トークンを使って、保護されたリソースにアクセスすることができます。このトークンには、アクセスが許可されているリソースの情報すべてが (暗号化された形で) 含まれています (一方、セッション・キーは単なるキーで、これ自体に意味を持っていません) 。
#Request.Options.AddBearerAuthorization Value('token')
ベアラ・トークンはベアラがアクセスできるリソースを実際に表したものなので、固定長ではありません。同じサービスからのトークンでも長さが異なり、非常に長い場合もあります。このフィールドを使って値を引き渡す場合、トークンの全長さをカバーできる長さでなければいけないことに注意してください。
次は: 要求本文へのコンテンツ追加