背景

  • 三方系统需要通过接口批量或周期调用宜搭的接口来操作数据。

说明

  • 宜搭有两个版本，依赖不同的账号体系和组织架构。目前开放给社会使用的就是对外版，是一个商业化的版本。不同版本在网关应用中上订阅的接口域名也是不一样的。请准确区分。 | 版本 | 域名 | 账号和组织 | 接口网关域名 | | —- | —- | —- | —- | | 对外版 | www.aliwork.com | 钉钉账号及钉钉企业组织架构 | s-api.alibaba-inc.com | | 对内版 | yida.alibaba-inc.com | 阿里集团工作账号及阿里集团组织架构 | u-api.alibaba-inc.com |

操作

  1. 阿里集团的工作人员请登陆AECP服务开放平台自行注册应用，获取应用的accessKey和secretKey。非阿里集团工作人员请先填报申请，申请通过之后会有技术支持同学联系。
  2. 能自行注册应用的用户请根据需求在应用中订阅需要访问的接口并申请。需要帮助注册应用的用户请整理需要访问的接口列表发给群内相应的答疑同学统一申请。
  3. 下载样例项目 call-yidaapi-demo.zip，获取的应用accessKey和secretKey填入gateway.properties配置文件中。样例项目是独立的Spring boot项目，用户根据需求做取舍。
  4. Maven可能下载不到的包。sdk.zip
  5. 接口说明参考。 | 版本 | 说明文档 | | —- | —- | | 对外版 | 对外接口文档 | | 对内版 | 对内接口文档 (该链接需要阿里巴巴内网权限才能访问) |

FAQ

  • 异常
    • 接口返回：”User not authorized to operate on the specified resource” ?? 。请先在AECP上注册应用，并且订阅服务。
    • 接口返回：{“_RequestId”:”0bb63bcb1564xxx367132336ee689”,”Message”:”The specified validate method is no access granted, value post”,”success”:false,”errorCode”:100,”HostId”:”u-api.alibaba-inc.com”,”Code”:”SecurityValidate”,”errorMsg”:””,”errorLevel”:”error”}?? 虽然已经注册了应用，但是还需要订阅服务。
    • 接口返回：{“_RequestId”:”0bef99281564975xxx3129d0b72”,”Message”:”The Api Key ‘test_201xxx1-LxQQO1xxxZBNn22’ is invalid”,”success”:false,”errorCode”:100,”HostId”:”u-api.alibaba.net”,”Code”:”InvalidAPIKey”,”errorMsg”:””,”errorLevel”:”error”} ?? 请检查参数domainName是否正确，u-api.alibaba.net 是日常，u-api.alibaba-inc.com是线上。不同环境注册的应用各自用不同accessKey，secretKey。
    • 接口返回：”The specified parameter ‘Missing required HTTP header: apiKey’ is not valid。”?? 请使用后端sdk调起接口，参考服务规约&错误码说明。
    • 接口返回：”接入秘钥不匹配，系统名:{0} 秘钥:{1} “?? 请区分线上和日常的应用ID和应用秘钥，不同环境，不同参数。没有请在”应用设置” -> “应用数据” 查看
    • 接口返回：”The specified parameter ‘Missing required HTTP header: X-Hmac-Auth-Signature’ is not valid？” 请使用后端sdk调起接口，参考服务规约&错误码说明。
    • ”/yida_vpc/form/getFormDataById.json接口只返回{“success”:true}“? 请检查formInstId的值，参考形式，FINST-08766LXXXXXNANGU213Y3LFYJ4。
    • 接口返回：{“success”:false,”errorCode”:”TIANSHU_000024”,”errorMsg”:”用户不存在”}? 对外版 接口userId 统一放 yida_pub_account。对内版接口可以传入集团工作账号，例如 “012345”,”WB123456”
  • 不支持
    • 被删除的表单数据，可以通过接口查到吗？ 不支持。