[TOC]

1: System

Error codes

2: API

2.0 API Common

2.1 Oauth

2.1.1 authorize

OAuth2.0 authorize api

用法: 获取authorization code

Usage: Get authorization code

url: /api/Oauth/authorize

method: GET

Error codes

Example

请求 https://www.upare.com/apis/Oauth/authorize/?client_id=123050457758183&redirect_uri=http://www.example.com/response&response_type=code

同意授权后会重定向 http://www.example.com/response&code=CODE

Return

{"error_code":0,"api_uri":"apis/Oauth/authorize","message":"Successful","authorization_code":"a7cbae5f75ea7514ed963182d8ae43f71dcb1e88"}

authorization_code (string): 用于提交到access_token接口的code

2.1.2 access token

用法: 获取access_token

######Usage: Get the access_token

url: /api/Oauth/accessToken

method: POST

Error codes

Return

 {"error_code":0,"api_uri":"URI","access_token": "ACCESS_TOKEN","refresh_token": "REFRESH_TOKEN","expires_in": 1234,"remind_in":3600,"uid":12341234}

access_token (string): 用户授权的唯一票据，用于调用开放接口，同时也是第三方应用验证用户登录的唯一票据，第三方应用应该用该票据和自己应用内的用户建立唯一影射关系，来识别登录状态，不能使用本返回值里的UID字段来做登录识别。

refresh_token (string): grant_type为refresh_token时可通过refresh_token获得access_token。

expires_in (int): access_token的生命周期，单位是秒数。

2.1.3 access token delete

用法: 删除输入的access_token

Usage: Delete the access_token

url: /api/Oauth/delete

method: POST

Error codes

2.1.4 access token revoke

用法: 撤销输入的access_token

Usage: Revoke the access_token

url: /api/Oauth/revoke

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Error codes

2.2 User

2.2.0 User common

Error codes

2.2.1 User login

用法: 用户登录

Usage: User login

url: /api/User/login

method: POST

Return

 {"error_code":0,"api_uri":"URI","login_token":"TOKEN","uid":UID}

Error codes

2.2.2 User register

用法: 用户注册

Usage: User register

url: /api/User/register

method: POST

Return

 {"error_code":0,"api_uri":"URI","login_token":"TOKEN","uid":UID}

Error codes

2.2.3 User settings

2.2.3.1 Set avatar

用法: 已经登录的用户设置头像

Usage: Set logged avatar

url: /api/User/setAvatar

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Requirements

The image format must be jpg or png (图片格式应该是jpg或png); File requirements are image types (文件类型应该是图片); The image background should be white (图像背景应该是白色); The file size should be between 40KB and 2MB (文件应该在40KB到2MB之间); The image width should between 412 pixels and 600 pixels (图像宽在:412 - 600像素之间); The image height should between 578 pixels and 800 pixels (图像高在:412 - 600像素之间);

2.2.3.2 Set user basic information

用法: 登录用户修改基本信息

Usage: Modify basic information of logged user

url: /api/User/modifyBasicInfo

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

2.2.3.3 Set user detail information

用法: 登录用户修改详细信息

Usage: Modify details of logged user

url: /api/User/modifyDetailInfo

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

2.2.3.4 Set sns unbind

用法: 解绑社会化登录

Usage: Unbind SNS accounts

url: /api/User/unbind

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Error codes

2.2.4 User SNS register

用法: 用户通过社会化账号注册. 如果type=reg 注册一个新的用户，如果type=log绑定已存在的uid

Usage: Register a uid to bind the SNS account. if type=reg register a new user else if type=log bind a exist uid

url: /api/User/snsreg

method: POST

Return

 {"error_code":0,"api_uri":"URI","login_token":"TOKEN","uid":UID}

2.2.5 Validate unique username

用法: 验证输入的用户名是否存在

Usage: Validate the unique username

url: /api/User/validateUniqueUsername

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Error codes

2.2.6 Validate unique email

用法: 验证输入的邮箱是否存在

Usage: Validate the unique email

url: /api/User/validateUniqueEmail

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Error codes

2.2.7 Send email or mobile verification code

用法: 向邮件或手机发送验证码

Usage: Send the code to a phone or an email

url: /api/User/sendcode

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

Error codes

2.2.8 Validate communication code

用法: 验证通过邮件或手机收到的验证码

Usage: Validate the code received

url: /api/User/validateCommunicationCode

method: POST

Return

 {"error_code":0,"api_uri":"URI"}

2.2.9 User messages

用法: 获取用户站内短信

Usage: Get a user’s messages

If id=null list all the messages else read the message of the id

url: /api/User/message

method: POST

Return

 {"error_code":0,"api_uri":"URI","data":"MESSAGE"}

2.2.10 User avatar

用法: 第三方获取不同尺寸的用户头像

Usage: Get user’s avatar in different sizes

url: /api/User/avatar

method: POST

Return

 {"error_code":0,"api_uri":"URI","avatar":"URL",,"width":W,"height":H,"version":V}

or

IMAGE

###### Error codes

2.2.11 User uid

用法: 通过用户名获取用户uid

Usage: Get user’s uid by username

url: /api/User/uid

method: POST

Return

 {"error_code":0,"api_uri":"URI","uid":"UID"}

2.2.12 User avatar upload api

用法: 第三方通过uid上传头像

Usage: Upload user’s avatar in the third app

url: /api/User/avatarUpload

method: POST

Return

 {"error_code":0,"api_uri":"URI","message":"successful"}

Error codes

Requirements

The image format must be jpg or png (图片格式应该是jpg或png); File requirements are image types (文件类型应该是图片); The image background should be white (图像背景应该是白色); The file size should be between 40KB and 2MB (文件应该在40KB到2MB之间); The image width should between 412 pixels and 600 pixels (图像宽在:412 - 600像素之间); The image height should between 578 pixels and 800 pixels (图像高在:412 - 600像素之间);

2.3 Calendar

2.3.1 Calendar events

用法: 获取登录用户待办事宜

Usage: Get logged user’s to-do events

2.3.2 Calendar add event

用法: 登录用户添加待办事宜

Usage: Logged user add to-do events

2.3.3 Calendar update event

2.4 Intercourse

2.4.1 Friends

2.4.1.1 List friends

用法: 通过登录uid获取用户列表

Usage: Get friends of logged uid

url: /api/User/friends

method: POST

2.4.1.2 Make a friend

用法: 向指定uid发出好友申请

Usage: Become friend to the uid input

url: /api/User/friendmake

method: POST

2.4.1.3 Delete a friend

用法: 删除指定uid的好友

Usage: Remove friend to the uid input

url: /api/User/frienddel

method: POST

2.4.1.4 Friends recommend

用法: 推荐好友

Usage: Recommend friends for logged user

url: /api/User/friendsrecommend

method: POST

Error codes

2.5 Content management

2.6 Image

2.6.1 Captcha

用法: 获取图片验证码

Usage: Get a captcha

url: /api/Image/captcha

method: GET/POST

2.6.2 Captcha verify

用法: 图像验证码验证

Usage: Validate a captcha

url: /api/Image/captchaVerify

method: GET/POST

Error codes

2.6.3 Encrypt a picture

用法: 加密图像

Usage: Encrypt a picture

url: /api/Image/chaos

method: POST

Error codes

2.6.4 Decrypt a picture

用法: 通过密码解密图像

Usage: Decrypt a picture by password

url: /api/Image/order

method: POST

Error codes