友情提示¶
Url 前缀¶
所有的API发布版本均以 bl.talelin.com/v1 开头:
GET /classic/latest
你需要使用如下URL来调用:
GET http://bl.talelin.com/v1/classic/latest
如何使用开发者key(appkey)访问Api?¶
目前所有Api的调用均需要使用开发者key。要想获取开发者key请访问 :www.talelin.com。当获 取到开发者key后,你有两种携带appkey的方式。
1.将开发者key加入到Http的Header里:
GET http://bl,talelin.com/v1/classic/latest
appkey: zCr1cd2jqewqeq
2.将开发者key作为请求参数:
GET http://bl.talelin.com/v1/classic/latest?appkey=zCr1cdeqweq
从规范性和安全性等多方面考虑,建议尽量使用方式二,而方式一仅供测试使用
关于POST、PUT等HTTP动作的数据提交¶
任何参数提交(除 GET 参数外)均需要严格符合JSON数据格式。不要以单引号表示JSON 的键或者值。在blink api中所有json数据字符串都必须以双引号" " 来引用。
错误的参数:
POST {'art_id':3, 'type': 100}
正确的参数:
POST {"art_id":3, "type": 100}
application/json¶
Api不会要求每次HTTP/HTTPS请求都在HTTP Header里附带 Content-type: application/json。 但是,如果你对你所使用的HTTP请求框架不熟悉的话,还是建议在HTTP头里加上Content-Type: application/json.
关于API调用的返回结果¶
所有HTTP请求只有2种类型的json返回结果:
返回资源的特定信息(如获取用户基本信息):
{ "content": "人生不能像做菜,把所有的料准备好才下锅", "fav_nums": 0, "img": "http://127.0.0.1:5000/images/movie.7.png", "index": 7, "like_status": 0, "pubdate": "2018-06-22", "title": "李安<<饮食男女>>", "type": 100 }
2. 返回一组消息,指明调用是否成功。这类消息通常具有共同的消息体样式。 通用返回格式是由msg、code及request三个参数组成的JSON响应体:
{
"error_code": 1000,
"msg": {
"art_id": [
"This field is required."
],
"type": [
"This field is required."
]
},
"request": "POST /v1/like/add"
}
error_code 表示错误码(错误码详情可以参见 Http Status Code );msg 表示错误信息; request 表示此次访问的HTTP地址。当错误消息未能解决你的问题时,请查找 错误返回码,以获取有效的错误消息。