集成前建议

1、巧用Postman模板（包括环境参数和接口示例）和Java示例代码。

1）Postman模板

我们建议开发者们在集成亿联UC服务端API时，在不了解API接口传参的情况下，优先根据接口文档中的快速开始步骤，下载并导入到您电脑中的Postman软件中后调用体验。

优点：利用Postman模板，结合API接口文档，能够在较短时间内帮助开发者们了解接口需要携带的header、body参数以及接口地址URL。熟悉后再开展集成工作，可达到事半功倍的效果。

注意事项：导入环境参数模板和接口示例模板后，在Postman软件中需要将两者配合起来使用，若您不了解两者的配合用法，建议先通过网络途径搜集资料了解。

若您已了解环境参数，请结合实际服务器部署信息，修改open-host字段的当前值（仅需修改域名部分，替换成您内网或云上部署的UC服务器IP或域名，若https监听端口有变更，需携带上:端口，若未变更，则无需携带），修改AccessKey ID和AccessKey Secret的当前值，此API鉴权秘钥获取方法请参考API获取token鉴权介绍，注意区分企业级和系统级接口，选择正确的秘钥，无特殊情况，选择企业级秘钥即可，系统级接口应用场景较少。若有疑问可咨询亿联售前技术工程师。

OpenApi(UC4X).postman_collection.json)

UC4X（866666企业级openapi）.postman_environment.json)

2）Java示例代码

若您具备Java开发经验，建议下载我们提供的Java示例代码UC_openapi-java-sdk-master.7z，利用test目录下的Demo.java进行接口调试，Demo中仅提供几个示例接口，具体请结合接口文档自行修改调试。

注意事项：需结合实际服务器部署信息，修改AccessKeyConfig中的鉴权秘钥accessKeyId和accessKeySecret，获取方法请参考API获取token鉴权介绍，注意区分企业级和系统级接口，选择正确的秘钥，无特殊情况，选择企业级秘钥即可，系统级接口应用场景较少。以及DefaultServer中的服务器地址和端口，接口仅支持通过https调用。若有疑问可咨询亿联售前技术工程师。

集成中建议

API接口调用只有2种问题，一是接口响应参数有误（基本不会出现，若有遇到可联系亿联售前技术工程师处理），二是接口调用失败。

1、接口调用失败排查建议

1）根据上述集成前建议，对比postman模板传参，核对传参。

2）注意接口请求发起方和UC服务器的时间需要同步准确互联网或内网时间服务器的时间，保证发起方和UC之间无时差。每个接口header中的timestamp参数建议使用时间函数保证实时准确性，单位是毫秒，例如postman软件自带的{{$timestamp}}000。

3）每个接口header中的nonce参数，需保证每次发起请求时均不同，一般使用随机数函数，例如postman软件自带的{{$guid}}，或自行定义随机数生成算法，最大长度32位。

4）UC服务端仅支持通过https协议访问调用接口，不支持http，请注意核对服务端的https监听端口是否修改过，默认为443时，调用api的接口地址无需携带端口，若修改为其他如20443，则接口请求地址中的服务器地址需注意携带上端口，如https://x.x.x.x:20443。

5）如上述集成前建议，获取API鉴权秘钥时，需注意系统级和企业级秘钥的区别（绝大多数应用场景都是取的企业级秘钥），避免使用了错误的秘钥，导致即使获取到了token，但是后续调用功能性接口却失败的问题，原因就是token和功能接口不匹配导致。

2、巧用FAQ

若您在调用API接口过程中，有其他疑问，请优先查阅下FAQ。点击跳转