レスポンス

HTTPレスポンスコード

popinfo Management API のレスポンスは以下のようなHTTPレスポンスコードを返す可能性があります。

認証API

コード	説明
200	正常系のレスポンスです。
301/302	API仕様などの変更によりリダイレクトを要求しています。リダイレクト先にアクセスして下さい。
その他	popinfo Management API の問題により、リクエストを処理できませんでした。

それ以外のAPI

コード	説明
200	正常系のレスポンスです。
301/302	API仕様などの変更によりリダイレクトを要求しています。リダイレクト先にアクセスして下さい。
401	認証に失敗しました。認証トークンが無効です。
429	過剰な同時アクセスをされたため、一時的にリクエストが制限されている状態です。リクエスト制限の解除をお待ちいただき、再度リクエストをお願いします。
その他	popinfo Management API の問題により、リクエストを処理できませんでした。

注意事項

現在のところ、503を返すケースは想定されていませんが、 APIの負荷状況をによってアクセストークンごとのリクエスト 頻度制限を実装する可能性があります。
正しくハンドリングしていただくようお願いいたします。

レスポンスボディ

HTTPレスポンスコード200の場合、レスポンスボディは、JSON 形式で返されます。

結果を 1つしか返さない API では、結果は result オブジェクトで返されます。結果を複数返す API では、結果は result 配列に含まれるオブジェクトで返されます。

キー名	型	説明
status	文字列	必ず OK の2文字が入ります。
result	※1	結果が入ります。

※1
単数の結果を返すタイプのAPIでは、オブジェクトになります。
複数返すタイプのAPIの場合は、たとえ結果が1件でも 配列になります。

結果を 1 つしか返さない API のレスポンスの例

{
  "status": "OK",
  "result" {
    "key1": value1,
    "key2": value2
  }
}

結果を複数返す API のレスポンスの例

{
   "status": "OK",
   "total_results": 50,
   "page": 1,
   "pages": 5,
   "result": [
      {
         "key1": value1,
         "key2": value2
      },
      {
         "key1": value3,
         "key2": value4
      },
      ...
   ]
}