发布API
一、接口描述
1. 功能描述
在启智AI开放平台上新增API,发布成功后将在启智AI开放平台展示并供开发者调用。
鉴权相关的公共参数将会被过滤。
当apiCode为空时,视为新发布api,将会新增一条api记录
当apiCode不为空时,视为对已有api更新,将覆盖当前apiCode所指代的api数据
二、请求说明
1. 接口地址 :
https://ai.openi.org.cn/api
2. 请求方式:
POST
3. 请求参数
(1)url请求参数
公共请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
accessToken |
String |
是 |
80d2b762ecb86593f9668526920f46c |
调用凭证 |
名称 |
类型 |
必填 |
示例值 |
描述 |
Content-Type |
String |
是 |
application/json |
标准编码格式 |
(3)body请求参数
名称 |
类型 |
必填 |
示例值 |
描述 |
apiCode |
String |
否 |
1101 |
接口编码,当apiCode为空时视为新发布api,当apiCode不为空时视为对已有api更新 |
name |
String |
是 |
文字识别 |
功能名称 |
description |
String |
是 |
是基于业界领先的深度学习技术,利用光学字符识别技术,将图片上的文字转换为可编辑的文本... |
功能描述和调用请求说明,可在此阐述调用的数据要求和注意事项等 |
category |
String |
是 |
|
能力所属分类 |
address |
String |
是 |
https://aiapi.jd.com/jdai/general_ocr |
接口请求地址 |
method |
String |
是 |
POST |
接口请求方式 |
requestUrlParams |
List |
否 |
见下方详细说明 |
url请求参数 |
requestHeadParams |
List |
否 |
见下方详细说明 |
header请求参数 |
requestBodyParams |
List |
否 |
见下方详细说明 |
body请求参数 |
requestParamSample |
String |
否 |
无 |
请求参数示例(markdown格式) |
responseBodyParams |
List |
否 |
见下方详细说明 |
返回参数 |
responseSample |
String |
否 |
无 |
返回结果示例(markdown格式) |
returnCodes |
List |
是 |
见下方returnCode详细说明 |
返回码 |
requestUrlParams**/requestHeadParams/requestBodyParams/**responseBodyParams的参数格式为List,其中Map的参数信息如下:
名称 |
类型 |
必填 |
示例值 |
描述 |
paramName |
String |
是 |
imageUrl |
参数名 |
paramType |
String |
是 |
String |
参数类型,包括String、Boolean、Number等等 |
required |
Boolean |
是 |
true |
参数是否必填,responseBodyParams无需此值 |
paramSample |
String |
是 |
imageUrl=https://img10.360buyimg.com/n1/.....a43.jpg |
参数的示例值 |
paramDescription |
String |
是 |
完整图片url |
参数的描述信息 |
returnCode的参数格式为List,其中Map的参数信息如下:
名称 |
类型 |
必填 |
示例值 |
描述 |
code |
String |
是 |
12001 |
返回码 |
msg |
String |
是 |
image does not exist |
返回码对应的信息 |
codeDescription |
String |
是 |
图像不存在 |
返回码说明 |
4、body请求参数示例
{
"name":"通用文字识别",
"description":"基于业界领先的深度学习技术,利用光学字符识别技术,将图片上的文字转换为可编辑的文本,为您提供场景丰富、的整图文字检测和识别服务。",
"address":"https://aiapi.jd.com/jdai/ocr_universal_v2",
"method":"post",
"reqUrlParams":[{
"paramName":"appkey",
"paramType":"String",
"required":true,
"paramSample":"80d2b762ecb86593f9668526920f46c",
"paramDescription":"您的appkey,可在买家中心控制台中获取"
},{
"paramName":"timestamp",
"paramType":"long",
"required":true,
"paramSample":"1541491668060",
"paramDescription":"请求的时间戳,精确到毫秒,timestamp有效期5分钟"
}],
"reqHeadParams":[{
"paramName":"Content-Type",
"paramType":"String",
"required":true,
"paramSample":"application/json",
"paramDescription":"标准编码格式"
}],
"reqBodyParams":[{
"paramName":"imageUrl",
"paramType":"String",
"required":false,
"paramSample":"imageUrl=https://img10.360buyimg.com/n1/.....a43.jpg",
"paramDescription":"完整图片url"
},{
"paramName":"imageBase64Str",
"paramType":"String",
"required":false,
"paramSample":"imageBase64Str=/9j/4AAQSk...",
"paramDescription":"图片base64编码"
}],
"reqCodeSample":"",
"respBodyParams":[{
"paramName":"code",
"paramType":"string",
"paramSample":"1001",
"paramDescription":"错误码"
},{
"paramName":"msg",
"paramType":"string",
"paramSample":"查询成功",
"paramDescription":"错误信息"
}],
"respSample":"",
"returnCode":[{
"code":"12001",
"msg":"image does not exist",
"codeDescription":"图像不存在"
}]
}
三、返回说明
1、返回参数
名称 |
类型 |
示例值 |
描述 |
code |
String |
1000 |
参见下方返回码 |
msg |
String |
查询成功 |
参见下方返回码对应msg |
apiCode |
String |
|
接口编码 |
2、返回示例
{
"code": "00",
"msg":"success",
"data":{
"apiCode":""
}
}
四、返回码
code |
对应msg |
说明 |
00 |
success |
成功 |
12005 |
"parameter value is null" |
参数值为null |