本文档说明如何访问开放接口
开放请求方法
- 接口请求地址
http://环境的ip:端口/开放接口的URL - 请求类型
POST/GET,根据创建的开放接口定义确定,当资源类型为“数据模型”时必须选择POST - 请求参数—自定义接口
请求转发给自定义接口时,调用方可在http请求中传body、query、path三种类型的参数,自定义接口的params入参可接收到以下格式的参数
{
"body": {
// 注意,请求的body是json类型,即header中的Content-Type为application/json
},
"query":{
},
"path":{
// 在开放接口URL中定义的参数,对应的参数与值的关系会解析到这里
}
}
-
请求参数—数据模型方法
请求转发给数据模型时,入参必须按数据模型方法的入参定义,详见【数据模型】中的【模型方法】
-
请求鉴权
在header中需携带token进行权限验证header中参数- token: 通过调用获取token接口取得,如果开放接口配置为允许“匿名访问”,则可不填
- userId: 执行接口的用户身份,非必填,不填时以admin用户身份执行接口
-
出参定义
{
// code等于0表示请求成功,其他表示失败
"code":0,
// 对应调用自定义接口或数据模型后的返回值
"data":{},
// msg为请求失败时的异常信息
"msg":""
}
请求token接口定义
- 请求地址: http://环境的ip:端口/ctg-lowcode/openApi/v1/getToken
- 请求方式: POST
- 请求入参(body):
{
"appKey":"",
"appSecret":""
}
// 说明:appKey、appSecret需在对应环境运行态—系统设置—应用凭证中查看
- 请求出参:
{
"code":0,
"data":{
"token":"实际的token值",
// token的有效期,单位:秒
"expireIn":1800
}
}