接口说明

接口说明

• 歌曲识别 ACRCloud，歌曲识别分为歌曲原声识别以及哼唱识别，基于音频的检索匹配，在ACRCloud上亿级曲库中找到对应的歌曲，识别内容中使用的音乐以及歌曲详细信息如歌名、歌手、专辑信息、发行时间和版权信息等。

• 部分开发语言demo如下，其他开发语言请参照文档进行开发，也欢迎热心的开发者到 讯飞开放平台社区 分享你们的demo。
  哼唱识别 demo java语言
  哼唱识别 demo python语言

  音乐识别 demo java语言
  音乐识别 demo python语言

• 集成歌曲识别 ACRCloud API时，需按照以下要求：

内容	说明
请求协议	http[s] (为提高安全性，强烈推荐https)
请求地址	哼唱识别：https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49 音乐识别：https://cn-east-1.api.xf-yun.com/v1/private/s29ebee0d 注：服务器IP不固定，为保证您的接口稳定，请勿通过指定IP的方式调用接口，使用域名方式调用
请求方式	POST
接口鉴权	签名机制，详情请参照下方鉴权说明
字符编码	UTF-8
响应格式	统一采用JSON格式
开发语言	任意，只要可以向讯飞云服务发起HTTP请求的均可
适用范围	任意操作系统，但因不支持跨域不适用于浏览器
音频属性	采样率8/16k、位长8/16bit、单/双声道
音频格式	mp3、speex
音频大小	文件base64编码后不超过10M

#鉴权说明

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。 通过在请求地址后面加上鉴权相关参数的方式，参数具体如下： http示例url：

https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49?authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMkdUVmN2Y0NQdDcyMWxnUUxseHhCNzVZS1lzb3RaMHM3TWh3WHJaTUNQdz0i&host=cn-east-1.api.xf-yun.com&date=Thu%2C+31+Mar+2022+02%3A42%3A08+GMT

鉴权参数：

参数	类型	必须	说明	示例
host	string	是	请求主机	cn-east-1.api.xf-yun.com
date	string	是	当前时间戳，RFC1123格式("EEE, dd MMM yyyy HH:mm:ss z")	Thu, 31 Mar 2022 02:42:08 GMT
authorization	string	是	使用base64编码的签名相关信息(签名基于hamc-sha256计算)	参考下方详细生成规则

• date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Thu, 31 Mar 2022 02:42:08 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

• authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开歌曲识别 ACRCloud页面可以获取，均为32位字符串。
2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

*注：* headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url =  https://cn-east-1.api.xf-yun.com/v1/private/s9884ba49
date = "Thu, 31 Mar 2022 02:42:08 GMT"

那么 signature原始字段(signature_origin)则为：

host: cn-east-1.api.xf-yun.com
date: Thu, 31 Mar 2022 02:42:08 GMT
POST /v1/private/s9884ba49 HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"    
date = "Thu, 31 Mar 2022 02:42:08 GMT"

则signature为

signature="2GTVcvcCPt721lgQLlxxB75YKYsotZ0s7MhwXrZMCPw="

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="2GTVcvcCPt721lgQLlxxB75YKYsotZ0s7MhwXrZMCPw="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例结果为：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iMkdUVmN2Y0NQdDcyMWxnUUxseHhCNzVZS1lzb3RaMHM3TWh3WHJaTUNQdz0i

#鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

HTTP Code	说明	错误描述信息	解决方法
401	缺少authorization参数	{"message":"Unauthorized"}	检查是否有authorization参数，详情见authorization参数详细生成规则
401	签名参数解析失败	{“message”:”HMAC signature cannot be verified”}	检查签名的各个参数是否有缺失是否正确，特别确认下复制的api_key是否正确
401	签名校验失败	{“message”:”HMAC signature does not match”}	签名验证失败，可能原因有很多。 1. 检查api_key,api_secret 是否正确 。 2.检查计算签名的参数host，date，request-line是否按照协议要求拼接 。 3. 检查signature签名的base64长度是否正常(正常44个字节) 。
403	时钟偏移校验失败	{“message”:”HMAC signature cannot be verified, a valid date or x-date header is required for HMAC Authentication”}	检查服务器时间是否标准，相差5分钟以上会报此错误

时钟偏移校验失败示例：

HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}

常见问题

#音乐识别和哼唱识别的区别？

答：音乐识别：通过听筒收集音乐播放信息，系统自动识别并检索出所播放的歌曲。     哼唱识别：用户对着话筒哼唱小段歌曲，系统自动识别并检索出所哼唱的歌曲。

#歌曲识别支持什么音频格式？

答：目前支持采样率8/16k、位长8/16bit、单/双声道的mp3或speex格式的音频。

#歌曲识别支持什么应用平台？

答：目前支持WebAPI应用平台。