Integration overview

更新时间:
复制 MD 格式

Intelligent Media Management provides a visual console, and also offers access methods such as OpenAPI online debugging and the Alibaba Cloud SDK. This topic describes the integration solutions that Intelligent Media Management supports.

OpenAPI integration

Intelligent Media Management provides OpenAPI operations for features such as project management and metadata management. Integrate these APIs into your applications for tasks like image processing, intelligent information recognition, and data processing. To learn how to use Alibaba Cloud OpenAPI, see Use Alibaba Cloud OpenAPI.

API version

Version

Description

2020-09-30

Recommended.

Online debugging

Debug Intelligent Media Management APIs directly in the OpenAPI Portal. Before you call an API, you must know its version, endpoint, request style, and calling method.

The OpenAPI Portal is organized into three main sections. On the left, you can navigate API categories for version 2020-09-30, including service regions, project management, media processing, and document processing. In the center, you can configure parameters for your request, including the service address and input values. On the right, you can find tabs for Documentation, Call Result, SDK Sample, and CLI Sample to help you debug your API calls and view the responses.

To debug the API, go to: https://api.aliyun.com/api/imm/2020-09-30/

Endpoints

You must use the service endpoint for your project's region. For example, the VPC endpoint for the China (Hangzhou) region is imm-vpc.cn-hangzhou.aliyuncs.com. For a complete list of endpoints, see Service endpoints.

User identity

Debugging APIs with your root Alibaba Cloud account poses a high security risk because it has unrestricted access to all your resources. We strongly recommend creating and using a RAM user for API calls and routine operations. Before calling an API, grant the RAM user only the required permissions. The RAM user must have permissions to use Intelligent Media Management. For instructions, see Grant permissions to a RAM user.

User identity

Support

Alibaba Cloud account

Supported

RAM user (Recommended)

Supported

As a best practice, always use a RAM user with the minimum required permissions for API calls.

Integration methods

Intelligent Media Management supports several integration methods, including SDKs. Choose the one that best suits your needs.

Alibaba Cloud SDK

  • Alibaba Cloud provides SDKs for multiple programming languages, including Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. By using an SDK, you can call OpenAPI operations with pre-built methods. The SDKs simplify development by handling common tasks such as request signing, timeouts, and retries, and returning structured responses. For more information, see Alibaba Cloud SDKs.

  • You can use an Alibaba Cloud SDK to call Intelligent Media Management APIs. For supported languages and installation instructions, see Intelligent Media Management SDK.

Alibaba Cloud CLI

  • Alibaba Cloud CLI allows you to use the aliyun command in a command-line terminal to interact with Alibaba Cloud services and manage your cloud resources. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI.

  • You cannot call Intelligent Media Management using the Alibaba Cloud CLI.

Custom integration

If the available SDKs do not meet your needs, you can build and sign your own requests to call the OpenAPI. However, this approach is not recommended. For more information, see Intelligent Media Management API overview and V3 request body and signing mechanism.

Notes

If an API call fails, check the returned error code to identify and resolve the issue. Also, verify your request parameters and their values. For more information, see the Error Code Center.

Alternatively, use the RequestID from the response or the error message from the SDK on the Alibaba Cloud OpenAPI Diagnostic Platform to diagnose the issue.