- 阅读
- 无需账户
- 格式
- 附示例的 REST 参考文档
- 沙盒密钥
- 拥有获批账户后
从一个请求开始
了解 API 最快的办法就是调用它。这四个请求适合作为第一个小时的练习:确认密钥有效、列出现有内容、创建作品,并订阅事件。
- 每个端点都附有请求和响应示例
- 错误按原因和修复办法逐一列出
- 示例可原样在沙盒中运行
最初的几个请求
请求示例GET/v1/me
响应
{ "id": "acc_5t1m9", "name": "Northfield Audio", "environment": "sandbox"}按资源划分的参考文档
- 作品
- 创建、更新、提交和下架作品,并管理其地区和日期。
- 曲目和资源文件
- 添加曲目,上传音频和封面,并设置署名、编码和分成。
- 投递
- 将作品发送到各平台,并跟踪每个目标从排队到上线或被拒收的全过程。
- 数据分析
- 按平台、地区、作品、曲目和日期读取播放量与下载量。
- 版税
- 列出结算单,读取明细行,并查看每位收款人的应收金额。
- Webhook
- 注册端点,选择它接收的事件,并查看已发送的内容。
快速入门,基于沙盒
- 1
创建沙盒密钥
申请账户,获批后从账户中复制密钥。
- 2
发出您的第一个请求
在 Authorization 请求头中带上密钥,调用 /v1/me 以确认密钥有效。
- 3
创建测试作品
提交一个带标题和艺人的作品,再向其中添加一首曲目。
- 4
模拟投递
在沙盒中投递,观察状态变化,全程不涉及任何平台。
一个请求头,即可接入
身份验证就是以 Bearer 令牌形式发送的 API 密钥。没有握手,也没有需要保持的会话。复制下面的内容,换上您的密钥,运行即可。
- 沙盒和生产环境使用不同的密钥
- 密钥可随时撤销
列出您的作品
bashcurl https://api.aevorarecords.com/v1/releases \ -H "Authorization: Bearer YOUR_API_KEY"关于文档的常见问题
不需要。参考文档是公开的。只有在需要密钥时才需要账户。
端点和响应都是一样的。沙盒中的投递会在到达任何平台之前停止,沙盒数据也与您的正式曲库分开存放。
新增内容会记录在更新日志中。破坏性变更会以路径中的新版本发布,因此您所基于开发的版本保持不变。