# 调用方式
# 1. 服务地址
在开发环境请使用测试地址。生产环境地址需要配置白名单,曲库数据需在商务合作达成后才授权可获取。
地址类型 | 地址 |
---|---|
开发环境 | https://dev-openapi.dmhmusic.com/ (opens new window) |
生产环境 | https://openapi.dmhmusic.com (opens new window) |
# 2. Demo
为方便快速接入,提供 PHP 和 JAVA 的 Demo。
JAVA Demo (opens new window)
PHP Demo (opens new window)
# 3. 鉴权规则
每个 API 用户会分配到一个 API KEY,这是一个随机字符串,用于第一次鉴权登陆使用。
API KEY 用于获取 API 调用的公钥和 cookie,需要每日更新鉴权 1 次。
公钥获取后需要保存,所有接口参数需要公钥进行 RSA 加密。注意:在每次授权登陆前,需情况 cookie,避免把上次的 cookie 带过去。
调用后,接口返回 cookie。所有接口的调用,需要带上 cookie 进行登陆。cookie 过期后,会新分配一个 cookie。
公钥和 cookie 是相对应的,在一起使用才会生效,建议一并储存。
鉴权登陆是独立在应用之外的,申请到证书之后,所有代码都可以共同使用。请注意 cookie 在多线程时,不要多套混着使用,这容易导致调用失败。同一时间内无论并发多少,只需要一套 cookie 和证书即可。
# 调用接口
调用地址:/OPENAPI/openApiLogin.json
调用方法:POST
# 输入参数
参数名 | 类型 | 是否必传 | 说明 |
---|---|---|---|
q_source | string | 必传 | 入参 API KEY 值 |
zone | string | 必传 | 国家地区代码,表示服务生效的地区。入参值为标准双字国家代码,如 CN。系统默认传值 CN |
# 返回结果
{
"state": true,
"errcode": "",
"errmsg": "",
"data": "-----BEGIN PUBLIC KEY----- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC/oUE3sUjHX3v1JumvX5YGxnjp f/bmaYI0e6Q1fThiktwBRpWo8iil+CslLuorQZs9zU8FsRBiFCMRvikdmZWa3BFx TylFoTEx1kNK916AxmHtaWNc0y1DvoRCfJb3FEb8LSq1D4jmOLAnD0/CKts8KBd+ 2s1GVJlrN0hjVvDtTwIDAQAB -----END PUBLIC KEY----- "
}
1
2
3
4
5
6
2
3
4
5
6
获取到的公钥在使用中注意要把头尾的 -----BEGIN PUBLIC KEY----- , -----END PUBLIC KEY----- 去掉。
# 错误码
错误码 | 说明 |
---|---|
apiSecure001 | md5 没通过认证 |
apiSecure004 | 需要验证码 |
apiSecure002 | 证书生成错误 |
apiSecure003 | 接口只能执行一次 |
apiSecure005 | 授权验证失败 |
apiSecure006 | 账号申请中暂时无法使用服务 |
apiSecure007 | 账号审核不通过 |
apiSecure008 | 余额不足已停止服务 |
apiSecure009 | once 设置长度错误 |
apiSecure010 | api 未授权 |
apiSecure011 | api 身份获取失败 |
searchx001 | 全局搜索模式仅支持 1 或 2 |
searchx002 | 需要设置标准双字国家代码 |