メインコンテンツまでスキップ

エラー定義

Web API で何らかのエラーが発生した場合、HTTP ステータスコードで 200 以外の値を応答するとともに、以下のようなエラー情報を持った JSON を返します。

{
  "status" : "failed",
  "error" : {
    "code" : 1,
    "message" : "Invalid API key or key not found."
  }
}

エラー時は status キーの値が failed になります。

処理失敗時のレスポンスで error キーに含まれる情報は以下のとおりです。

注記
  • code は「エラーコード」です。プログラムによるエラー判定にご利用ください
  • message は「エラーメッセージ」です。エラー発生時に人が見て判断する場合にご利用ください

エラー一覧​

HTTP StatusCodeMessage説明
4011Invalid API key or key not found.API キーが指定されていないか、存在しないAPIキーです
5003Operation failed.ユーザ情報のマージに失敗しました
4044Invalid authentication token or token not found.ワンタイムトークンが指定されていないか、存在しないワンタイムトークンです
4005Required parameter not found.必須のパラメーターが指定されていません
4006Invalid parameter.パラメーターに間違いがあります
4047Entity not found.指定されたユーザが存在しません
4038Field existed and overwrite disabled.すでに紐付けされているため上書きできません
4049Specified provider not associated with this user.このユーザに指定されたログインプロバイダのログイン情報がありません
40010Incompatible operation.指定されたログインプロバイダではこの機能を利用できません
40011Specified provider settings incomplete.指定されたログインプロバイダの設定が完了していません
40312Privilege not granted.ログインプロバイダの設定でシェア機能が有効化されていません
40513Method not allowed.HTTP メソッドが許可されていません（POST メソッドしか使えない API を GET メソッドなどで呼び出した場合に発生します）
40915Specified provider already associated with this user.指定されたログインプロバイダは、すでにこのユーザと紐付いています
40016Duplicated primary key.指定された primary_key は、すでに別のユーザに関連付けられています
40017Unacceptable operation.処理を実行するにはパラメーターで強制動作するように指定する必要があります
40319Provider’s access token has expired.アクセストークンの期限が切れています
40320Option contract needed.処理を実行するにはオプション契約が必要です
40321Access denied.ソーシャルログインマネージャーで設定されたIPアドレス制限によりアクセスが制限されました
42922Too many requests.リクエスト回数制限を超えています。HTTP ヘッダー X-RateLimit-Reset に制限解除日時が含まれます

システムエラー​

システムに問題が発生した場合、Web API のレスポンスで HTTP ステータスコード 5xx 番台を応答します。システムエラーが発生した際には JSON による HTTP レスポンスボディは返されません。

HTTP Status一般的なエラー内容説明
500Internal Server ErrorソーシャルPLUS システムに問題が発生しています
502Bad Gateway不正なリクエストがサーバーから拒否される場合に発生します
503Service Unavailableメンテンス時に意図して応答するステータスコードです
504Gateway Timeout処理に時間がかかりすぎてタイムアウトしました。プロバイダ側の障害時に発生することが多いエラーです
に最終更新