用戶信息

查看賬號(hào)信息

• 地址: /api/person/self 或 /api/person/[person oid]

• 方法: GET

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: person

• URL參數(shù): person oid

• 請求范例

  curl -v -A CURL -b cookies.txt http://127.0.0.1:8888/api/person/self
  
  > GET /api/person/self HTTP/1.1
  > User-Agent: CURL
  > Host: 127.0.0.1:8888
  > Accept: */*
  > Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
  

• 響應(yīng)范例

  {
  "obj":{
  "_id":{
  "date":1473671277244
  }
  },
  {
  "token_type":"android",
  "token":"22dde87aa7bbfde548179ef3933cb60f249592c2",
  "is_enable_aliase":false,
  "created_at":{
  "date":1448875673502
  },
  "updated_at":{
  "date":1473772757475
  },
  "lastlogin_by":"",
  "enable":false,
  "email_is_checked":false,
  "phone_is_checked":true,
  "push_sos_enable":true,
  "push_fence_enable":true,
  "push_abnormal_enable":true,
  "push_message_enable":true,
  "push_lowpower_enable":true,
  "push_system_enable":true,
  "push_fall_enable":true,
  "push_env_enable":true,
  "auth_type":"weixin",
  "auth_uid":"oXm9utw5vTIi4PV4bZtcFFeFJqS8",
  "auth_updated_at":{
  "$date":1448875673502
  },
  "register_app":"",
  "is_device_owner":false,
  "devices":[

  ],
  "groups":[
      {
      "$oid":"565ba687bf483c7369e5b4a4"
      }
  ],
  "$community":{
  
  },
  "$devices":[
  
  ],
  "$groups":[
      {
      "_id":{
          "$oid":"565ba687bf483c7369e5b4a4"
      },
      "owner":{
          "$oid":"565ba619bf483c7369e5b4a3"
      },
      "name":"18680555070家",
      "created_at":{
          "$date":1448875783707
      },
      "is_public":false,
      "members":[
          {
          "$oid":"565ba687bf483c7369e5b4a5"
          },
          {
          "$oid":"578f41442642511a2446b9f0"
          },
          {
          "$oid":"57a40ebe2642514b25a49076"
          },
          {
          "$oid":"57d108c4264251061d083074"
          },
          {
          "$oid":"57d6144126425121e8b81865"
          }
      ]
      }
  ]
  },
  "success":true,
  "obj_name":"person"
  

  }

修改賬號(hào)信息

• 地址: /api/person/[person oid]/edit
• 方法: POST
• 驗(yàn)證方法: Cookie: user
• 響應(yīng)對象: person
• URL參數(shù): person oid
• 請求參數(shù): person

請求范例

curl -v -A CURL -b cookies.txt -d "email=bbbb@abc.com" http://127.0.0.1:8888/api/person/565ba619bf483c7369e5b4a3/edit?email=bbbb@abc.com

> POST /api/person/53eeb1cb7fcc8b0e11a170a7/edit HTTP/1.1
> User-Agent: CURL
> Host: 127.0.0.1:8888
> Accept: */*
> Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
> Content-Length: 18
> Content-Type: application/x-www-form-urlencoded

響應(yīng)范例

{
  "success": true
}\

設(shè)置口令

• 地址: /api/person/change_passwd 或 /api/person/[person oid]/change_passwd
• 方法: POST
• 驗(yàn)證方法: Cookie: user
• 響應(yīng)對象: 無

請求參數(shù)

請求范例

 curl -v -A CURL -d 'old_password=123456&password=123456' -b cookies.txt http://127.0.0.1:8888/api/person/change_passwd?old_password=123456&password=123456 
 > POST /api/person/change_passwd HTTP/1.1
 > User-Agent: CURL
 > Host: 127.0.0.1:8888
 > Accept: */*
 > Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
 > Content-Length: 34
 > Content-Type: application/x-www-form-urlencoded

響應(yīng)范例

{
  "success": true
}

設(shè)置缺省組

被設(shè)置的用戶必須已經(jīng)是組的成員才能設(shè)置為缺省組涯肩。

• 地址: /api/person/change_group 或 /api/person/[person oid]/change_group

• 方法: POST

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù):

  名稱	必須	類型	說明
  group	是	string

• 請求范例:

  curl -v -A CURL  -b cookies.txt -d 'group=54d1d3ede138231996630d8c' http://127.0.0.1:8000/api/person/change_group?group=54d1d3ede138231996630d8c
  

• 響應(yīng)范例

  {
  "success": true
  }

修改頭像

• 地址: /api/person/change_avatar 或 /api/person/[person oid]/change_avatar

• 方法: POST

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù)

  名稱	必須	類型	說明
  upfile	是	multipart

• 請求范例

   curl -v -A CURL  -F 'upfile=@2.jpeg' -b cookies.txt http://127.0.0.1:8888/api/person/change_avatar
  

• 響應(yīng)范例__

  {
    "success": true
  }
  

查找賬號(hào)

• 地址: /api/person/find

• 方法: GET

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: person

• URL參數(shù): 無

• 請求參數(shù)

  名稱	必須	類型	說明
  small	否	int	0/1 是否用簡化版本顯示person對象, 缺省為0
  username	否	string	在 username 中模糊匹配方式查找用戶
  nickname	否	string	在 nickname 中模糊匹配方式查找用戶
  phone	否	string	在 phone 中模糊匹配方式查找用戶
  email	否	string	在 email 中模糊匹配方式查找用戶
  imei	否	string	在 imei 中模糊匹配方式查找用戶

• 請求范例

  curl -v -A CURL -b cookies.txt 'http://127.0.0.1:8000/api/person/find?phone=18680555070&small=1'
  

• 響應(yīng)范例

  {
  "objs":[
  {
  "_id":{
  "date":1473671277244
  }
  },
  {
  "token_type":"android",
  "token":"22dde87aa7bbfde548179ef3933cb60f249592c2",
  "is_enable_aliase":false,
  "created_at":{
  "$date":1473773865601
  }
  }
  ],
  "avatar":"18680555070.png",
  "avatar_url":"/media/avatar/200/18680555070.jpg",
  "gender":"male",
  "auth_type":"weixin",
  "auth_uid":"oXm9utw5vTIi4PV4bZtcFFeFJqS8",
  "register_app":"",
  "devices":[

      ],
      "groups":[
      {
          "$oid":"565ba687bf483c7369e5b4a4"
      }
      ],
      "$community":{
  
      },
      "$devices":[
  
      ],
      "$groups":[
      {
          "_id":{
          "$oid":"565ba687bf483c7369e5b4a4"
          },
          "owner":{
          "$oid":"565ba619bf483c7369e5b4a3"
          },
          "name":"18680555070家"
      }
      ]
  }
  ],
  "page":{
  "page_count":1,
  "rows_per_page":20,
  "total":1,
  "page_current":1
  },
  "success":true,
  "obj_name":"person"
  

  }

注：如需將推送接口接入app轴捎，請聯(lián)系柏頤科技進(jìn)行聯(lián)調(diào)缘挽。推送僅限于app

增加推送設(shè)備

• 地址: /api/person/attach

• 方法: POST

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù):

  名稱	必須	類型	說明
  token	是	string
  token_type	否	string	ios, android, 缺省ios
  is_enable_aliase	否	boolean	保留, 缺省False

• 請求范例:

  curl -v -A CURL -b cookies.txt -d 'token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android' 
  

  http://127.0.0.1:8000/api/person/attach?token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android

• 響應(yīng)范例:

  {
    "success": true
  }
  

移除推送設(shè)備

• 地址: /api/person/unattach

• 方法: POST

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù):

  名稱	必須	類型	說明
  token	是	string
  token_type	否	string	ios, android, 缺省ios

• 請求范例:

  CURL -b cookies.txt -d 'token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android' 
  

  http://127.0.0.1:8000/api/person/clear_notification?token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android l

• 響應(yīng)范例:

  {
    "success": true
  }
  

清除推送消息

• 地址: /api/person/clear_notification

• 方法: POST

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù):

  名稱	必須	類型	說明
  token	是	string
  token_type	否	string	ios, android, 缺省ios

• 請求范例:

  CURL -b cookies.txt -d 'token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android' 
  

  http://127.0.0.1:8000/api/person/clear_notification?token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android l

• 響應(yīng)范例:

  {
    "success": true
  }
  

查看推送的消息

• 地址: /api/notification/

• 方法: GET

• 驗(yàn)證方法: Cookie: user

• 響應(yīng)對象: 無

• 請求參數(shù):

  名稱	必須	類型	說明
  token	是	string
  token_type	否	string	ios, android
  created_at	否	string	表示一個(gè)時(shí)間范圍洼畅。YYYYMMDD[HH][-NN] YYYYMMDD為年月日喳钟，[]內(nèi)為可選參數(shù)问拘，HH為時(shí)隘梨，YYYYMMDD[HH]一起描述了開始時(shí)間宣羊，-NN表示前面時(shí)刻之后的多少小時(shí)的數(shù)據(jù)，描述了結(jié)束時(shí)間
  title	否	string	模糊查詢輸入內(nèi)容

• 請求范例:

  CURL -b cookies.txt http://127.0.0.1:8000/api/notification?token=d471b6c9243c7fc2483f8d8167c4b04443140eab&token_type=android
  

• 響應(yīng)范例:

  {
  "objs":[

  ],
  "page":{
  "page_count":0,
  "rows_per_page":20,
  "total":0,
  "page_current":1
  },
  "success":true,
  "obj_name":"notification"
  

  }