Edge Developer Platform
  • Image Renderer
    • Product Introduction
    • Getting Started
    • Development Guide
      • Overview
      • Signature URL
      • API Generation
    • Open API
      • Overview
      • API Documentation
      • API List
        • Account Verification
        • Get Template List
        • Get Template Instance
        • Get Image Signed URL
    • FAQs
Docs Overview/
Edge Developer Platform/
Image Renderer/
Open API/
API List/
Get Image Signed URL/

Get Image Signed URL

Interface description

Request Domain: image.edgeone.app.
Dynamically generate a signed URL for a new image under a specified template by setting parameter variables of the user account.
Note:
1. All interfaces require ApiKey + UserId for API authentication. The API Key is your private key. Please avoid leaking the API Key when invoking the API.
2. The Params field in the request parameters needs to be formatted in JSON according to actual needs. Only key-value pairs within template configuration parameters are allowed. You can pass fewer key-values, but you cannot pass key-values outside the template configuration parameters.
3. The RequestId in the response can be used for tracing and troubleshooting issues.

URL Path

/api/v1/GetTemplateSignedUrl

Request method

POST

Request headers

Content-Type: application/json

Request parameters

Parameter Name
Type
Required
Description
ApiKey
string
Yes
User's `ApiKey`
UserId
string
Yes
User ID
Id
string
Yes
Template ID
Params
string
Yes
Template Parameters

Response data type

JSON

Sample response

{
    "code": 0,
    "data": {
        "Response": {
            "SignedUrl": "********"
        }
    },
    "message": "ok",
    "requestId": "612d593d-xxxx-xxxx-xxxx-xxxx"
}

Field description

code (int): Response status code, 0 indicates success.
data (object): Object containing the actual response data.
Response (object): Actual business response data.
SignedUrl (string): Template signature URL.
message (string): Response message.
requestId (string): Request ID.