Back to top

API Documentation

システム利用者管理

利用者一覧取得

一覧取得
GET/user/list{?sid,key}

処理概要

  • 登録されている全てのユーザの基本情報を取得する

  • 取得する情報は、ID、姓名、メールアドレスとする

Example URI

GET /user/list?sid=3&key=00000000
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": [
    {
      "customer_id": 3,
      "name01": "テスト",
      "name02": "太郎",
      "email": "userc@example.com"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "status",
    "message"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "No data",
  "data": "No users were found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（該当なし）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

利用者ID取得

ID取得
GET/user/info{?sid,key,email}

処理概要

  • メールアドレスが合致するユーザIDを取得する

  • 取得する情報はID、メールアドレスおよびパスワードとする

  • 確認のために姓名も併せて取得する

Example URI

GET /user/info?sid=3&key=00000000&email=userc@example.com
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

email
string (required) Example: userc@example.com

ユーザのメールアドレス

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": [
    {
      "customer_id": 3,
      "name01": "テスト",
      "name02": "太郎",
      "password": "userc",
      "email": "userc@example.com"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "status",
    "message"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "No users were found",
  "data": "No users were found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（該当なし）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

詳細な利用者情報の取得

詳細情報取得
GET/user/detail{?sid,key,id}

処理概要

  • ユーザIDに該当するユーザの全情報を取得する

Example URI

GET /user/detail?sid=3&key=00000000&id=1
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

id
number (required) Example: 1

ユーザID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": [
    {
      "customer_id": "1",
      "name01": "ユーザーＡ",
      "name02": "太郎",
      "kana01": "ユーザーエー",
      "kana02": "タロウ",
      "zip01": "100",
      "zip02": "0001",
      "pref": "13",
      "addr01": "千代田区千代田",
      "addr02": "1",
      "email": "usera@example.com",
      "email_mobile": "em",
      "tel01": "03",
      "tel02": "1770",
      "tel03": "3333",
      "fax01": "03",
      "fax02": "1770",
      "fax03": "4444",
      "sex": "1",
      "job": "1",
      "birth": "1970",
      "password": "usera",
      "reminder": "1",
      "reminder_answer": "テスト",
      "secret_key": "00000000",
      "first_buy_date": "0000",
      "last_buy_date": "0000",
      "buy_times": "0",
      "buy_total": "0",
      "point": "0",
      "note": "memo",
      "status": "1",
      "create_date": "2017",
      "update_date": "0000",
      "cel01": "c1",
      "cel02": "c2",
      "cel03": "c3",
      "del_flg": "0",
      "mailmaga_flg": "0",
      "url": "url"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "status",
    "message"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "No users were found",
  "data": "No users were found"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（該当なし）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

利用者情報の更新

情報更新
POST/user/update{?sid,key}

処理概要

  • JSON形式で渡したユーザ情報に更新する（ユーザIDはJSONに含まれる）

Example URI

POST /user/update?sid=3&key=00000000
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "customer_id": "1",
      "name01": "ユーザーＡ",
      "name02": "太郎",
      "kana01": "ユーザーエー",
      "kana02": "タロウ",
      "zip01": "100",
      "zip02": "0001",
      "pref": "13",
      "addr01": "千代田区千代田",
      "addr02": "1",
      "email": "usera@example.com",
      "email_mobile": "em",
      "tel01": "03",
      "tel02": "1770",
      "tel03": "3333",
      "fax01": "03",
      "fax02": "1770",
      "fax03": "4444",
      "sex": "1",
      "job": "1",
      "birth": "1970",
      "password": "usera",
      "reminder": "1",
      "reminder_answer": "テスト",
      "secret_key": "00000000",
      "first_buy_date": "0000",
      "last_buy_date": "0000",
      "buy_times": "0",
      "buy_total": "0",
      "point": "0",
      "note": "memo",
      "status": "1",
      "create_date": "2017",
      "update_date": "0000",
      "cel01": "c1",
      "cel02": "c2",
      "cel03": "c3",
      "del_flg": "0",
      "mailmaga_flg": "0",
      "url": "url"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": "\"\""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "string"
    }
  },
  "required": [
    "status",
    "message"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "error",
  "data": "No error"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（更新失敗）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

新規利用者情報の作成

新規情報作成
POST/user/create{?sid,key}

処理概要

  • JSON形式で渡したユーザ情報に更新する（ユーザIDは含まない）

  • 識別キー（UUID）を新規に生成して割り当てる

  • 戻り値として利用者IDを返す

Example URI

POST /user/create?sid=3&key=00000000
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

Request
HideShow
Headers
Content-Type: application/json
Body
{
  "data": [
    {
      "name01": "ユーザーＡ",
      "name02": "太郎",
      "kana01": "ユーザーエー",
      "kana02": "タロウ",
      "zip01": "100",
      "zip02": "0001",
      "pref": "13",
      "addr01": "千代田区千代田",
      "addr02": "1",
      "email": "usera@example.com",
      "email_mobile": "em",
      "tel01": "03",
      "tel02": "1770",
      "tel03": "3333",
      "fax01": "03",
      "fax02": "1770",
      "fax03": "4444",
      "sex": "1",
      "job": "1",
      "birth": "1970",
      "password": "usera",
      "reminder": "1",
      "reminder_answer": "テスト",
      "first_buy_date": "0000",
      "last_buy_date": "0000",
      "buy_times": "0",
      "buy_total": "0",
      "point": "0",
      "note": "memo",
      "status": "1",
      "create_date": "2017",
      "update_date": "0000",
      "cel01": "c1",
      "cel02": "c2",
      "cel03": "c3",
      "del_flg": "0",
      "mailmaga_flg": "0",
      "url": "url"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "array"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": 99
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "number",
      "description": "利用者ID"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "error",
  "data": "No error"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（更新失敗）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

利用者情報の削除

情報削除
GET/user/delete{?sid,key,id}

処理概要

  • 利用者IDに該当する利用者情報を削除する（del_flgを1にする）

Example URI

GET /user/delete?sid=3&key=00000000&id=1
URI Parameters
HideShow
sid
number (required) Example: 3

呼出元のサイトID

key
string (required) Example: 00000000

0000-3333-1111-000000000000 (string, required) - 呼出元のサイトキー

id
number (required) Example: 1

ユーザID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": true,
  "message": "success",
  "data": "\"\""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "成功"
    },
    "message": {
      "type": "string",
      "description": "成功"
    },
    "data": {
      "type": "string",
      "description": "成功"
    }
  },
  "required": [
    "status",
    "message"
  ]
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "{入力値}is used invalid character",
  "data": "{入力値}is used invalid character"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（バリデーションエラー）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "status": false,
  "message": "error",
  "data": "error"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean",
      "description": "失敗（該当なし）"
    },
    "message": {
      "type": "string",
      "description": "失敗理由"
    },
    "data": {
      "type": "string",
      "description": "暫定処理としてmessageと同じ内容を返している"
    }
  },
  "required": [
    "status",
    "message",
    "data"
  ]
}

Generated by aglio on 17 May 2017