一般規定

  • REST APIはベースURLの下にある:

/public/external/api

  • すべてのリクエストはPOSTで送信されなければならない。
  • REST APIはHTTPS経由のリクエストのみをサポートしています。
  • リクエストには以下のヘッダーが含まれていなければならない:
編集

ヘッダー名



ヘッダー値



説明



コンテンツタイプ



application/json



固定



オーサー



123…xyz



APIアクセス」タブのAPIキー



署名



Base64エンコードされた署名



で生成されたペイロードの署名。


APIアクセス」タブのプライベート・キー


  • リクエスト・ボディは、以下の値を含むjsonエンコードされたオブジェクトでなければならない:
編集

フィールド



フィールド例 値



説明



アプリ



v2/device/listdevices



API名



時間



1529662725



クライアントマシンのUnixタイムスタンプ(UTC)。


最大許容時間差


クライアントとサーバー間は30


分。


  • 成功すると、APIは要求されたデータ(下記のクエリーを参照)とHTTPステータスコード200を返す。
  • エラーが発生した場合、HTTPステータスコードはエラーに応じて4xxから5xxの間となり、レスポンスオブジェクトは、人間が読めるエラーメッセージのリストを含むキー “errors “を持つ配列を含む。
  • デバイスにマッチするデータがない場合は、空の配列が返される。
  • デバイスIDが存在しない場合、返されるデータはNULLとなる。
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.