Request Syntax

最終更新日:2023-03-06 16:26:06

API ドメイン

api.cloudv.haplat.net

プロトコル

リクエストは、HTTPまたはHTTPS経由で送信できます。リクエストのセキュリティを確保するために、HTTPS経由でリクエストを送信することをお勧めします。

リクエスト方法

API は、POST または GET をサポートします。

  • POSTリクエストの場合:「application/json」、「application/x-www-form-urlencoded」のcontent-typeに対応します。
  • Getリクエストの場合:「content-type:application/x-www-form-urlencoded」のみに対応します。

リクエストパラメータ

リクエストは適切なAPIに送信され、共通パラメータと各APIの特定パラメータを搬送する必要があります。

HTTPヘッダーの場合、一般的に使用される一部のヘッダーを除き、X-WS-AccessKey、X-WS-Timestamp、認証、content-Type、ホストなど、クラウドVoDで定義されたいくつかの追加のヘッダーを含める必要があります。

以下はクラウドVoDで定義されたヘッダーです。

ヘッダー 説明
X-WS-AccessKey あなたの AccessKey ID。コンソールのセキュリティ設定>アクセス制御>ユーザー情報管理>アクセスキー管理で確認できます。
X-WS-Timestamp 現在のタイムスタンプ、単位秒。
Authorization HTTP標準認証ヘッダー。詳細については、認証V3をご覧ください。
content-Type 実際にサーバーに送信されたデータの種類。
host クラウドVoD APIドメイン、 api.cloudv.haplat.netに固定。

# Common Headers
User-Agent: Mozilla/5.0 (Windows NT 5.1; rv:5.0) Gecko/20100101 Firefox/5.0
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: zh-cn,zh;q=0.5
Accept-Encoding: gzip, deflate
Accept-Charset: GB2312,utf-8;q=0.7,*;q=0.7
Connection: keep-alive
# Cloud VoD Headers
Authorization: WS3-HMAC-SHA256 Credential=AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE, SignedHeaders=content-type;host, Signature=792dcb6d648a456a030c9c6683fa7bde2a31cb4c72cfeaa354da000adf7c288d
Content-Type: application/json; charset=utf-8
Host: api.cloudv.haplat.net
X-WS-AccessKey: AKIDz8krbsJ5yKBZQpn74WFkmLPx3EXAMPLE
X-WS-Timestamp: 1564645579

文字エンコード

すべてのリクエストとレスポンスは、UTF-8でエンコードする必要があります。