Introduction
You can use coScene's open platform OpenAPI to build scripts and applications for automated workflows, system integration, and extending application functionalities.
Before making API calls, please follow these steps:
-
Obtain the OpenAPI endpoint. The endpoint of the OpenAPI will vary depending on the version of coScene products you are using. Refer to your current platform address to obtain the latest endpoint.
-
Retrieve API key through authorization. All open interfaces require authentication using an API key. Please keep it safe and do not upload it to public platforms.
After completing the above steps, you can start using coScene's OpenAPI platform.
Swagger
coScene provides an OpenAPI YAML file compliant with the OpenAPI 3.0.3 standard, which can be downloaded from OpenAPI YAML. You can also directly access the Swagger Editor to view information about related interfaces online.
SDK
coScene OpenAPI provides SDKs for various languages, and you can view information about supported language SDKs on buf.
Examples
For different SDKs, coScene provides example codes in commonly used languages such as Go, Java, and Python, available at the openapi-example project. If you need example code in other languages, please contact coScene developers for assistance.