PDF《API 接口文档》

1 项目信息 项目名称 ThinSNSV3 ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page

7 客户名称 项目经理 供应商名称 智士软件(北京)有限公司 实施经理

2 文档介绍 2.1编写目的 本文档是为 ThinSNSV3 产品 API 说明文档,为ThinsnsV3 客户端开发者、系统继承者 提供演示说明和 API 说明文档.

3 接口设计 3.1接口基本说明 API 核心文件在 ThinsnsV3/core/OpenThinsnsV3/Api.class.php,其他应用 API 存放 于ThinsnsV3/addons/api . API 文档存放于SVN , 文件路径为:ThinsnsV3/ThinsnsV3Client/ 手 册文 档.ThinsnsV3Api 以 应用 为划分模 块,命名 为:{MODULE_NAME}Api.class.api, {MODULE_NAME}为应用名. API 为WeiboStatusesApi.class.php,每个 API 必须继承于核心 API,如: ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page

8 3.2接口调用 根据 HTTP 协议,通过 GET/POST 形式,接口将返回 JSON 格式数据.接口调用过程如 下: 1) requst_key token + 地址:http://SITE_URL/index.php?app=api&

mod=Oauth&

act=request_key + 参数:无+返回值:JSON 格式的 request token 2) 获取用户的 oauth_token 和oauth_token_secret、uid + 地址:http://SITE_URL/index.php?app=api&

mod=Oauth&

act=authorize + 参数类型:POST + 参数: - uid:[必须] 经过 DES 加密的用户 ID 或用户 Email(使用第1步的 request token 做DES 加密) - passwd:[必须] 经过 DES 加密的用户密码(使用第1步的 request token 做DES 加密) + 返回值:JSON 格式的 oauth_token、oauth_token_secret、uid 数据 3) 调用 Api + 地址: http://SITE_URL/index.php?app=api&

mod=MODULE_NAME&

act=ACT_NAME&

oauth_token=OAUTHER_ TOKEN&

oauth_token_secret=OAUTH_TOKEN_SECRECT + 参数类型:参考 Api 定义 + 参数:参考 API 定义 + 返回值:参考 API 定义 ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page

9 4 名词解释 名词/术语 名词解释 时间戳: 时间戳是自

1970 年1月1日(00:00:00 GMT)以来的秒数.它也 被称为 Unix 时间戳(Unix Timestamp)

5 接口定义 注: (返回结果结为 JOSN,为方便阅读和传输) 5.1 认证(OauthApi) 5.1.1【request_key】Oauth/request_key 接口名称: Oauth/request_key 接口描述: 请求加密用的 request_key ,必须是

8 位的字符串. 演示地址: 输入参数: (string) format,返回格式可选 json/php/test 格式(默认 json 格式,为了 阅读方便,以下文档中输出结果均以 test 格式显示) 输出结果: array(1) { [0] =>

string(8) THINKSNS } 字段说明 成功时: 返回用户加密的字串 失败时: 其他说明: 即用来加密的 key,系统默认为 THINKSNS ,应用 . ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page

10 5.1.2【用户认证】Oauth/authorize 接口名称: Oauth/authorize 接口描述: 通过 Oauth 进行认证 演示地址: 输入参数: (string) uid,帐号 DES 加密(必填) (string) passwd,密码双重加密(必填) (string) format,返回格式可选 json/php/test 格式(默认 json 格式,为了 阅读方便,以下文档中输出结果均以 test 格式显示) 输出结果: { oauth_token : e33011b454a4b7b111763e3b94899276 , oauth_token_secret : 55f6675d74411dd42cfe1297818281d5 , uid :

8 } 失败: { message : 验证失败 , code :

00001 } ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page

11 字段说明 成功时: uid:用户 UID oauth_token:用户 oauth_token oauth_token_secret:用户 oauth_token_secret 失败时: Message:错误信息 Code:错误代号 其他说明: 1,双重加密是先进行 MD5 加密, 在进行 DES 加密. 加密的 key 用request_key.

2 ,oauth_token 和oauth_token_secret 为API 每次请求必带参数 5.2 消息(NotifytionApi) 5.2.1【通知总数】 Notifytion/get_message_count 接口名称: Notifytion/get_message_count 接口描述: 获取通知总数 演示地址: 输入参数: (int) mid,当前登录用户 UID(选填,默认当前用户) (string) oauth_token (必填) (string) oauth_token_secret (必填) (string) format,返回格式可选 json/php/test 格式(默认 json 格式,为了 阅读方便,以下文档中输出结果均以 test 格式显示) 输出结果: int(2) ? ZhiShiSoft Co., Ltd. Soicax_Api 文档 Page