文档

安装

更新时间:

本文主要介绍如何基于服务端SDK编写代码调用临云镜服务端API,让您不用复杂编程即可快捷集成开发。

服务端SDK接入说明

  • 服务端SDK封装了对临云镜服务端API的调用请求和响应。

  • 支持所有的API概览,并提示了相应示例代码。

  • 支持多种开发语言,包括Java、Python、PHP、.NET、Go、Node.js。

1、开发环境准备

服务端SDK支持Linux、Windows、Mac等多种平台和运行环境,请提前安装好对应开发语言的编译器或解释器,并完成相关环境配置,具体版本要求可参考各语言SDK的安装文档。

2、SDK安装

  • 版本说明

服务端SDK最新版本为3.0.2,发布记录和更新日志请参见【服务端SDK升级日志】,请确保您安装的是最新版本,否则部分API或返回字段可能不准确,导致调用异常,线上方式具体参考【添加依赖配置】。

  • 安装操作

需要安装TDSR库,各语言SDK安装操作如下:

<dependency>
   <groupId>com.aliyun</groupId>
   <artifactId>tdsr20200101</artifactId>
   <version>3.0.2</version>
</dependency>

  • 使用说明

实际上,各语言版本的SDK可以互相参考,接口调用、错误解决方法不需要局限于开发语言,均可以互相参考,寻找解决方法,如仍无法解决,可前往阿里云SDK问答社区提问。

3、基本调试

根据【公共参数】说明,进行参数配置及接口请求测试,以便后续进行正式开发接入工作。

说明

如后续使用标注工具SDK、前端引擎SDK,建议将项目管理、主场景管理、子场景管理相关接口完成接入。其中子场景上传较为特殊,请详见示例代码。

要了解更多接口请参考【API概览】。