概述
PRS 提供遵从 REST 规范的 HTTP API,以让你用任何支持发送 HTTP 请求的设备来与 PRS 进行交互。与此同时,为方便开发者使用,目前还提供了 Javascript SDK。
API 基本约束
对于 POST
和 PUT
请求,请求主体必须使用指定的 JSON
格式,而且 HTTP Header 的 Content-Type 需要设置为 application/json
,同时所有请求数据都必须包装在 payload
字段内。
如下面示例,name
和 title
是需要请求的数据,包装在 payload
内。
{
"payload": {
"name": "test name",
"title": "test title"
}
}
API 环境
PRS 给开发者提供了两个环境, 正式环境域名: press.one
, 测试环境域名: beta.press.one
。
两个环境的数据不共通,开发者账号以及 DApp 需要分别创建。 上面两个域名相当于
${host}
;根据具体的 API 文档,补齐请求URL地址后访问
API 版本
当前使用的 API 版本为 v2,
API 资源列表
URL | Method | 功能 |
---|---|---|
https://${host}/api/v2/apps/${address}/authenticate | POST | 拿到授权之后的 code 换取 access token |