API共通仕様

認証、レスポンスコード、エラー処理などの共通仕様を説明します。

認証方法

apiKey方式

OpenPNE3.8からは、ログイン後の全ページに、図のようなapiKeyが埋め込まれています。 スマートフォンAPIでは、このキーを利用して、APIアクセスを行います。

共通エラー処理

可能な限りHTTPの共通エラーレスポンスコードに準拠したエラーコードを返します。

認証失敗時

HTTPステータスコード401が返ります。

該当するAPIが見つからない

HTTPステータスコード404が返ります。

リクエストパラメータが不十分

HTTPステータスコード400が返ります。 ※エラーメッセージが含まれる場合は、200を返し、JSON形式でレスポンスメッセージを出力します。

レスポンスメッセージ

スマートフォンAPIは共通して、status / message のデータを出力します。

status:API呼び出しの成功可否を返します。success / error。

message:エラー発生時に、エラーの内容を説明します。 例:「target_idが指定されていません。」