CheckNerds 文档中心


说明

认证:


CheckNerds API的请求通过POST方式发送,在发送每一条请求时,参数都必需附上如下认证信息才能通过服务器认证
Post 请求附带参数
apiappid: 应用程序认证id
servicekey: 应用程序服务key, 需sha256加密发送
apiuserid: API调用用户id
apikey: API调用用户key, 需sha256加密发送




测试期间的公开APP, 每小时200次请求
公开的应用程序认证ID:74611
servicekey: 0b34d532fca3bf5efd72be82f3edc8b1
api用户key,请登录后进入设置页面,点击“生成APIKEY"按钮生成


获取用户基本信息(名称,头像,网址、加入日期等公开信息)


Post请求到: http://www.checknerds.com/service/user/
userid: 需要获取用户信息的用户id


返回值:
认证不通过:

403 No Such User
403 Application Verifiction Failed.
403 UserID Authentication Failed.
403 User Limitation exceed.

认证通过:
{'website': u'http://cnborn.net', 'datejoinin': '2008-08-27 13:58:33.185277', 'id': '35', 'avatar': 'http://www.checknerds.com/image?avatar=35', 'name': u'CNBorn'}



获取用户事项信息


Post 请求到 /service/item/
userid: 需要获取用户事项信息的用户id (注意测试中此用户必需与API登录用户一致,暂不开放获取其它用户信息)
done: 获取的事项是否已经完成 有三个选择 True表示已完成 False未完成 空字符串(不提交此项)表示均可
routine: 获取的事项是否是每日必做事项 daily表示每日必做事项 空字符串(不提交此项)表示一般事项
public: 获取的事项是否公开 public表示公开,空字符串(不提交此项)表示均可(即包括公开及非公开事项)
maxitems: 获取事项的数目,空字符串(不提交此项)默认为10,最大限制为100


返回值:
认证不通过:

403 No Such User
403 Application Verifiction Failed.
403 UserID Authentication Failed.
403 User Limitation exceed.

认证通过:
[{'comment': u'', 'donedate': datetime.datetime(2009, 6, 22, 17, 34, 1, 32261), 'name': u'A Blog post of OpenParty - Looking fish at Willowy bank', 'done': True, 'routine': u'none', 'date': datetime.datetime(2009, 6, 22, 17, 29, 16, 816587), 'id': '378'},.......]

返回数据的字段说明:
'id', 项目id
'name', 项目名称
'comment', 项目说明
'date', 项目创建日期
'done', 项目是否完成,完成为 True, 未完成为 False
'expectdate', 项目期望完成日期,未设置为 None, 设置则返回 Python Datetime 格式
'donedate', 项目实际完成日期,未完成为 None, 设置则返回 Python Datetime 格式
'routine', 项目是否为坚持性项目, 'none'为一般项目, 'daily'为每日必做项目
'public', 项目是否公开,'private'为非公开项目,'publicOnlyforFriends‘仅对朋友公开,'public'完全公开
'tags', 项目标签,以半角逗号分割,例如 "工作,编程"



完成一个项目


Post请求到: http://www.checknerds.com/service/doneitem/
itemid: 需要完成的项目id,此项目所有者必须为apiuserid中认证的用户


返回值:
认证不通过:

403 No Such Item
403 Application Verifiction Failed.
403 UserID Authentication Failed.
403 User Limitation exceed.
403 You can't manipulate other user's items.

认证通过:
200 OK



撤销完成一个项目


Post请求到: http://www.checknerds.com/service/undoneitem/
itemid: 需要撤销完成的项目id,此项目所有者必须为apiuserid中认证的用户


返回值:
认证不通过:

403 No Such Item
403 Application Verifiction Failed.
403 UserID Authentication Failed.
403 User Limitation exceed.
403 You can't manipulate other user's items.

认证通过:
200 OK



添加事项信息


添加项目到API调用用户中
Post 请求到 /service/additem/
name: 事项名称
comment: 事项说明,请少于500字,超过的部分会被程序自动截断
routine: 获取的事项是否是每日必做事项 daily表示每日必做事项 none表示一般事项
public: 获取的事项是否公开 public表示公开,private表示非公开事项
date: 事项预计完成日期,请使用与Python datatime模块输出一致的时间格式提交,空字符串默认为此项目没有时间限制
tags: 事项分类标签,字符串,不同标签请使用半角逗号分割。如所示标签在用户已有标签中不存在,则会自动创建。


返回值:
认证不通过:

403 Application Verifiction Failed.
403 UserID Authentication Failed.
403 User Limitation exceed.

认证通过并创建成功:
会返回一个数字,即所创建项目的id编号

© CNBorn, 2008-2009, Powered by Google App Engine