- 接口
- REST 和 JSON
- 身份验证
- API 密钥,每个环境一套
- 沙盒
- 测试投递,不涉及任何平台
四次调用,从草稿到结算单
API 沿用作品在控制台中的流程:创建、投递,随到随读数据,最后读取结算单。选择一个调用,即可看到发送什么、返回什么。
- 请求和响应均为 JSON
- 错误信息会指出出错的字段及原因
- 沙盒和生产环境使用相同的调用
Engine API
请求示例POST/v1/releases
请求正文
{ "title": "Night Drive", "artist": "Mira Kaya", "label": "Northfield Audio", "release_date": "2027-03-12"}响应
{ "id": "rel_8f2k1", "status": "draft", "upc": null}端点之外还有什么
调用只是集成中很短的一部分。真正让集成在无人看管时依然稳定运行的,是下面这些部分。
- Webhook
- 当投递状态变化、作品上线或结算单就绪时接收事件,无需轮询。
- 幂等键
- 写入请求带上一个键,重试时会返回第一次的结果,而不会再创建第二个作品。
- 分页
- 列表会返回游标。传回游标即可获取下一页,顺序始终一致。
- 沙盒
- 独立的环境,有自己的密钥。投递会从头到尾完整运行,并在到达任何平台之前停止。
- 版本管理
- 版本号是路径的一部分。破坏性变更会以新版本发布,因此您所基于开发的版本保持不变。
- 速率限制
- 每个响应都会告诉您剩余多少额度,被限流的请求会告诉您何时重试。
从第一个密钥到正式投递
- 1
获取密钥
申请账户。获批后,创建沙盒密钥。
- 2
在沙盒中开发
创建作品并运行测试投递,直到您的集成能处理所有状态。
- 3
申请生产环境权限
告诉我们您要开发什么。我们审核后会签发生产密钥。
- 4
投递
换成生产密钥,同样的调用就会送达真实的平台。
关于 Engine 的常见问题
不需要。参考文档是公开的。只有当您需要密钥时,才需要账户,而账户须通过申请开通。
可以。通过 API 创建的作品会出现在控制台中,在控制台中创建的作品也可以通过 API 读取和投递。
投递会经历与真实投递相同的状态,并发送相同的 Webhook,但不会向任何平台发送内容。