このページではAPIの共通仕様について記載しています。

APIの共通仕様

a. APIのプロトコルはHTTPまたはHTTPSが使用可能です。

b. すべてのAPIのレスポンスはJSON形式で、次の項目を含みます。

Name Type Description
status string API result status value.
description string (Optional) status detail information.

  • Example of success API response

    {
    "status":"OK"
}

  • Example of error API response

      {
      "errCode": 198,
      "status": "error",
      "description": "Input parameters are require"
  }

レスポンスのステータス一覧

API response can be following status values.

Status Value Code Description
OK 0 API process succeeded.
  1 Update data successfully.
  132 No result
ERROR 11 You don’t have enough permission to do this action!
  100 The user developer set wrong data
  101 The App with id given does not exist.
  102 App database not defined.
  103 Cannot create app database
  104 Not match between appId, appVersion and authentication token
  105 App does not exist.
  106 The App id or app version is not correct.
  107 The app not assign for groups user belong to.
  108 AppID and UserID do not match
  109 Input data is not valid.
  110 User does not exist
  111 User name or password is not correct
  112 Not match between user infomation and authentication token
  113 Account inactivated
  114 Password expired
  115 Exceed password retry limit
  116 Unwilling To Perform
  117 Account expired
  118 User was not authorized
  119 System error from Security Provider
  120 The token is expired.
  121 Token does not exist.
  122 User token is required.
  130 Record does not exist or data blocking
  131 Process error.
  133 Role/Group does not exist
  134 Group does not exist
  135 API result status value.
  136 User account is invalid
  137 Duplicate key value exception
  160 Not match between deviceUDID and authentication token
  161 The device already registered for this device and app.
  162 The device token already registered by another device.
  163 Please register you device before login.
  198 Input parameters are required
  199 Request not found.
  201 Problem occurs during saving user session.
  202 Cannot connect to app database
  205 Problem occurs during deletion user session.
  206 Problem occurs during saving device register.
  210 Problem occurred when saving transaction
  211 Transaction Id existed
  212 Problem occurred when getting record
  220 Cannot excute query
  301 Invalid authorization response.
  302 Invalid token response.
  600 Upload failed, file dose not contain data or invalid data
  601 Upload failed, cannot create file path name. Invalid app or compnay
  602 Upload failed, cannot connect or insert data to Database
  603 Max file size exceeded
  604 Request do not set Content-Length
  605 Request file not found
  701 Service does not exist。サービスが見つかりません。
  702 Service name must be unique.サービス名はユニークである必要があります。
  800 Can not store push message.
  801 Target users or devices don’t exit.
  990 This table does not change.
  991 Cannot get table tracking change of records.
  992 Data does not exist with that token.
  993 Requested table is empty or does not exist.
  994 Cannot post data
  995 Table does not exist

HTTP Header

AppPotのAPIは下記のヘッダーが必要です。

Auth Token

認証が必要なAPIは、HTTPヘッダにトークン情報を設定して呼び出します。

Name Data Format
apppot-token String