计费概述
耳像穴位识别API提供预付费计费模式。
产品价格
免费试用
首次开通服务的用户,可以申请一次免费试用服务,开通服务后即可在开放平台的个人资料查看,免费资源包有效期为90天,90天内若资源包次数未使用完且未购买预付费资源包,则过期作废。若已购买预付费资源包且超额调用,则超额部分转为预付费,若未购买预付费资源包或预付费资源包用完,则停止服务。
预付费
预付费资源包不支持购买后退费。具体预付费资源包套餐价格参见购买详情页。
计费与抵扣方式
计费方式
调用次数包,含有资源可调用次数,支持同时购买多个,购买后的资源包配额次数可叠加,且同时启用生效。
抵扣方式
抵扣顺序为:免费资源包 > 预付费资源包。
退款说明
耳像穴位识别API提供预付费计费模式,暂不支持退款。
资源通知
用户在购买资源成功后,我们针对以下情况会通过站内信及短信的方式通知到用户,具体如下表所示:
购买成功通知
用户在购买资源包成功后,会收到购买资源包成功通知。
调用量预警通知
当您的资源包用量不足总量的10%时,会收到资源包剩余量预警通知。
调用量耗尽通知
当您的资源包用量为总量的0%时,会提醒用户资源包调用量已用完,资源包用完后即停止服务。
API文档
术语和定义
失败请求:耳像穴位识别API将错误码为“内部错误”的请求和因为耳像穴位识别API故障导致的用户正常请求未能到达耳像穴位识别API服务器端的请求视为失败请求,但不包括以下类型的请求:
因采用不适当的访问模式导致请求超出耳像穴位识别API的 QPS(每秒钟请求数量),造成耳像穴位识别API失败的请求(错误码为:内部错误)。
您的应用程序受到黑客攻击而导致耳像穴位识别API失败的请求(错误码为:内部错误)。
用无效图片而导致耳像穴位识别API识别失败的请求。
有效请求:耳像穴位识别API服务器端收到的请求视为有效请求,但不包括以下类型的请求:
未开通/授权服务和鉴权失败的请求、欠费请求、密钥错误请求。
在符合流程和手续完备的情况下,可以提供相关信息,包括关键组件的运行日志、运维人员的操作记录、客户操作记录等信息。
业务流程说明
请求/响应参数展示
请求地址
https://api .miaolangzhong.com
请求方法
公共参数
传入参数说明
注:公共参数需通过headers传递,不在请求参数中体现
secretId
Integer
是
在平台“个人资料”处可查看秘钥Id
timestamp
String
是
请求端口时间,时间格式为毫秒级时间戳,如: 1199116800000.过期时间为一个小时,若当前参数与实际时间超出一个小时,会引起签名过期错误.
sign
String
是
'签名;将多个参数拼接并进行MD5加密.
说明:sign加密规则,按照以下顺序将参数追加拼接secretId+ timestamp+ secretKey;如:
your_secretId + your_timestamp + your_secretKey
拼接完成后,再进行MD5加密,最终sign结果为:
secretKey在“个人资料”处可查看(请妥善保管,不要泄露到公开文档/前端代码/版本控制中)
业务接口展示-生成耳像穴区
说明:以海量的耳像大数据为基础,结合机器学习、深度学习的神经网络算法,对耳朵进行国标穴位分区和穴区坐标点运算。
左耳请求地址: /api/ear/leftEarAcupoint
右耳请求地址:/api/ear/rightEarAcupoint
earImgPath
String
是
耳像图片网络地址
notifyUrl
String
是
回调通知地址,需要用户自行提供公网可访问url地址.请填写完整url地址,包括http/https
注:请求或上传的识别诊断照片大小限制在1M以内,照片在无色光美颜条件下拍摄效果为最佳。耳像尺寸为500X500像素
耳像图片说明:
将耳朵完整放置在拍摄区域内
光线充足,不逆光、不曝光、不反光
确保头面部倾斜15-30度角,与耳廓垂直
JSON请求示例
POST
https://api.miaolangzhong.com/api/ear/leftEarAcupoint
Accept:application/json;
Content-Type:application/json;charset=utf-8;
{
"earImgPath":
"http://image.miaolangzhong.com/img-ear/szf_ear_20210520193422.jpg"',
"notifyUrl": "http://www.notifyUrl.com/callback.php"
}
注:以上参数为模拟参数,无法进行真实请求,请用户替换所属真实参数,再进行请求操作.
status
String
是
请求状态码,1表示成功,0表示失败
data参数json内容详解
notifyCode
String
是
回执号,用于关联后续回调
JSON响应示例
HTTP/1.1 200 OK
"status": "1"
"message": "成功"
"data": {
"notifyCode": "DB1ECE93-DEAA-2091-B938-26CD1C132B4B"
}
目前支持HTTP/HTTPS方式回调,采用POST请求,正文部分数据为JSON格式,字符集为UTF-8.
传入参数说明
接口简介
此请求由妙郎中平台主动推送,请求地址为“生成耳像穴区”接口中,用户传入的notifyUrl参数
status
String
是
请求状态码,1表示成功,0表示失败
message
String
是
异常状态码中文说明
img
String
耳像分区处理后的图片url地址
acupoint
String
耳像分区后每个国标穴区的坐标,格式为:
国标穴位名称:[[穴区坐标X],[穴区坐标Y]]
{
"status": "1"
"message": "成功"
"data":{
"notifyCode": "DB1ECE93-DEAA-2091-B938-26CD1C132B4B"
"img":
"http://image.miaolangzhong.com/img-ear/szf_ear_20210520193422.jpg"',
"acupoint":{
"\u5fc3": [[317.90690221550744, 321.3320432719042, 324.4393000375904, 326.9245125708098,
328.544410953317, 329.1404282449366, 328.65422212046803, 327.1333858229717,
324.72678940553607, 321.67000729324286, 318.2622586170968, 314.83711756070005,
311.72986079501385, 309.24464826179445, 307.6247498792872, 307.02873258766766,
307.5149387121362, 309.0357750096325, 311.44237142706817, 314.4991535393614,
317.90690221550744], [268.57447152844446, 269.060677652913, 270.5815139504093,
272.98811036784497, 276.0448924801382, 279.45264115628424, 282.877782212681,
285.9850389783672, 288.4702515115866, 290.0901498940938, 290.6861671857134,
290.19996106124484, 288.6791247637485, 286.27252834631287, 283.21574623401966,
279.8079975578736, 276.38285650147685, 273.27559973579065, 270.79038720257125,
269.170488820064, 268.57447152844446]], "\u4ea4\u611f": [238.3946346564182,
143.9513310884259], "\u8247\u89d2": [262.22241958266477, 180.661794393177]
}
}
业务接口展示-查询AI调用记录
说明:根据 notifyCode 查询耳像分析 AI 调用的处理状态与结果记录。
请求地址: /api/ear/getAIRecord
请求参数
notifyCode
String
否
回调回执号(创建耳像穴区接口返回的 notifyCode),用于查询对应记录的处理状态。
JSON 请求示例
POST https://api.miaolangzhong.com/api/ear/getAIRecord
{
"notifyCode": "937BB929-BEB7-7EE7-4F07-722E2E332C23"
}
响应参数
status
Integer
请求状态码。0-失败,1-成功,其他非0/1值见具体业务错误码。
message
String
中文提示信息。status=1 时 message="成功"。
JSON 响应示例
{
"status": 1,
"message": "成功"
}
业务接口展示-查询用户资源
说明:用于查询当前用户当前可用的接口调用资源包(次数包、有效期、剩余次数等)。
请求地址: /api/ear/getResource
请求参数
本接口为查询当前用户资源,无需业务参数,公共参数 secretId/timestamp/sign 必传(请求体为空)。
JSON 请求示例
POST https://api.miaolangzhong.com/api/ear/getResource
响应参数
status
Integer
请求状态码。0-失败,1-成功。
JSON 响应示例
{
"status": 1,
"message": "成功"
}
业务接口展示-添加耳像分析报告
说明:调用本接口把耳像分析结果(左右耳原图、分区图、穴区坐标、被检测人信息)提交入库,生成一份耳像分析报告。可结合"生成耳像穴区"接口的回调结果一起使用。
请求地址: /api/report/add
请求参数
leftEarImg
String
是
左耳原图 URL 地址。
rightEarImg
String
是
右耳原图 URL 地址。
leftEarImgPartition
String
是
左耳分区图 URL(生成耳像穴区接口回调返回的 img)。
rightEarImgPartition
String
是
右耳分区图 URL。
leftEarArea
String
是
左耳国标穴区坐标(生成耳像穴区回调的 acupoint 序列化字符串)。
rightEarArea
String
是
右耳国标穴区坐标。
gender
String
是
被检测人性别,0-女,1-男。
JSON 请求示例
POST https://api.miaolangzhong.com/api/report/add
{
"leftEarImg": "https://example.com/ear/left.jpg",
"rightEarImg": "https://example.com/ear/right.jpg",
"leftEarImgPartition": "https://example.com/ear/left_partition.jpg",
"rightEarImgPartition": "https://example.com/ear/right_partition.jpg",
"leftEarArea": "{\"心\":[[...],[...]],\"肺\":[[...],[...]]}",
"rightEarArea": "{\"心\":[[...],[...]],\"肺\":[[...],[...]]}",
"gender": "1",
"name": "张三",
"age": "30",
"phone": "13800138000"
}
响应参数
接口成功时返回 200 OK,详细返回结构以实际接口响应为准(每条记录包含姓名/手机号/年龄/性别/左右耳原图/分区图/穴区/创建时间等)。
业务接口展示-查询耳像分析报告
说明:分页查询当前用户的耳像分析报告。可按手机号/姓名过滤。
请求地址: /api/report/list
请求参数
page
Integer
否
页码,从 1 开始,默认 1。
JSON 请求示例
POST https://api.miaolangzhong.com/api/report/list
{
"phone": "13800138000",
"name": "张三",
"page": 1,
"size": 20
}
响应参数
接口成功时返回 200 OK,详细返回结构以实际接口响应为准(每条记录包含姓名/手机号/年龄/性别/左右耳原图/分区图/穴区/创建时间等)。