Skip to content

Add cloud service usage instructions for IDMP SDK #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wingwing2005 merged 1 commit into from
Jan 23, 2026
Merged

Add cloud service usage instructions for IDMP SDK #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/07-develop/01-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,7 @@ java -jar openapi-generator-cli.jar generate -i idmp-v1.x.x.x.json -g python -o
```

对于其它语言，将 -g 参数替换为对应语言的名称即可，将 --library 参数替换为对应语言的库名称。另外不同语言有不同的附加参数，可通过--additional-properties 指定，具体请参考-properties 指定 ，具体请参考 [OpenAPI Generator 文档](https://openapi-generator.tech/docs/generators) 点击对应语言名称查看详情。

## 云服务使用 SDK

如果您使用的是 [IDMP 的云服务版](https://idmp.taosdata.com/), 则不能使用上述登录方式。因为云服务的登录认证流程和企业版有所不同，云服务的前端代码封装了比较复杂的登录逻辑。建议您先通过浏览器登录云服务， 然后从浏览器的开发者工具从请求标头 “Authorization” 获取认证 token， 最后将 token 设置到环境变量中即可。
4 changes: 4 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/current/07-develop/01-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,7 @@ java -jar openapi-generator-cli.jar generate -i idmp-v1.x.x.x.json -g python -o
```

For other languages, simply replace the `-g` parameter with the corresponding language name, and the --library parameter with the corresponding library name. Additionally, different languages have different additional parameters, which can be specified via --additional-properties. For details, please refer to the [OpenAPI Generator Documentation](https://openapi-generator.tech/docs/generators) and click on the corresponding language name for more information.

## Using SDK with Cloud Service

If you are using the [cloud version of IDMP](https://cloud.tdengine.com/), the login method described above cannot be used. Since the login authentication process for the cloud service differs from the enterprise version, the front-end code of the cloud service encapsulates more complex login logic. It is recommended to first log in to the cloud service through a browser, then obtain the authentication token from the "Authorization" request header in the browser's developer tools, and finally set the token in environment variables.