nvPress REST API提供了访问nvPress的程序接口,该接口通过JSON发送和接收数据。
本手册仅介绍部分常见的API。
鉴权
nvPress REST API是面向开发者的功能,使用了通用的授权限制:公开网站公开的内容使用公开的REST API接口,而私人的内容、用户信息等则需要授权才能访问。
接口的授权鉴定是在Cookie
中带入nvnonce
实现的。在服务器收到该参数后,将判断用户的权限,等级合格的用户才能访问该接口。
对于无权限的用户,将返回错误401,并带有“Permission declined!”字样的信息。
通用的信息
接口请求成功,将返回指定的内容。若请求失败,将返回error失败原因。因此在获取到数据后,请务必先判断error信息。
示例
{
error: "参数错误",
error_code: 123 // 内部代号
}