You need to enable JavaScript to run this app.
导航
Java SDK接入
最近更新时间:2024.07.12 14:50:44首次发布时间:2024.07.12 14:50:44

1.引入Maven依赖

环境要求:JDK版本必须不低于 1.8

cdp-openapisdk-java
  com.volcengine
  {version}

具体版本号见 maven中央仓库SDK中央仓库地址
具体源码见GitHub仓库地址(源码更新会有延迟)
引用SDK版本前请先确认CDP版本,勿要使用高版本的SDK请求低版本的CDP

2.获取必要参数信息
access_key:BDxxxxx
secret_key:xxxxx
domain:域名
account:绑定的用户名

access_key,secret_key,domain 获取方式见接入须知
注意:使用OpenApi时,CDP资源权限与此绑定账户权限相关联,请勿越权访问

3.构建使用代码

1.STS方式-推荐使用

ApiClient apiClient = new ApiClient(
                "",
                "",
                "",
                "/open_platform/openapi"
        );
        // 用于调试 OpenAPI 请求, 生产环境可以去掉
        apiClient.setDebugging(true);

2.传统使用方式-已废弃

ApiClient apiClient = new ApiClient(
                "",
                "",
                "/open_platform/openapi"
        );
        // 用于调试 OpenAPI 请求, 生产环境可以去掉
        apiClient.setDebugging(true);

3.API调用示例

文档中示例代码仅供参考

// 使用 AK SK 访问
private final ApiClient client = new ApiClient(
    "ak",
    "sk",
    "account",
   "https://xxxx/open_platform/openapi"
);
private final SegmentationApi segClient = new SegmentationApi(client);
@Test
public void sdkTest() throws Exception {
    try {
        File file = segClient.downloadSegFile(1, 1000008, "txt", false);
        System.out.println(file.getName());
        ByteDanceResponseSegmentationUploadResp res = segClient.uploadSegFile(file, 1);
        System.out.println(res);
    } catch (ApiException e) {
        throw e;
    }
}

@Test
public void sdkAsyncTest() throws Exception {
    try {
        segClient.legacyGetSegmentListAsync(
            1, 1, 10, null, null, null, null, null, null, null, null,
            new ApiCallback() {

                public void onFailure(ApiException e, int statusCode, Map> responseHeaders) {}

                public void onSuccess(ByteDanceResponseSegmentationListResp result, int statusCode, Map> responseHeaders) {
                    System.out.println(result);
                }

                public void onUploadProgress(long bytesWritten, long contentLength, boolean done) {}

                public void onDownloadProgress(long bytesRead, long contentLength, boolean done) {}
            });
        Thread.sleep(5000);
    } catch (ApiException e) {
        throw e;
    }
}

3.使用建议

1.使用STS方式时,请保存 ApiClient,构造器会自动获取Token并保存,不建议每次请求都新构建ApiClient(每次新构建都会触发一次获取Token操作)

2.SDK版本与CDP版本相对应,CDP版本号对应SDK前两位版本号,例如CDP版本1.22,则SDK对应版本为1.22.X其中X为SDK对应的patch,建议使用相匹配的版本以获得最新功能和最佳使用体验

3.引用SDK版本前请先确认CDP版本,勿要使用高版本的SDK请求低版本的CDP