エッジ開発者プラットフォーム
  • エッジ画像レンダリング
    • 製品紹介
    • クイックスタート
    • 開発ガイド
      • 概要
      • 署名付き URL
      • APIで生成
    • 公開API
      • 概要
      • API 概要
      • インターフェース一覧
        • アカウント認証
        • テンプレート一覧の取得
        • テンプレート例を見る
        • 画像の署名の取得
    • 一般的な問題
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
ドキュメンテーション概要/
エッジ開発者プラットフォーム/
エッジ画像レンダリング/
公開API/
インターフェース一覧/
アカウント認証/

アカウント認証

Interface description

Request Domain: image.edgeone.app.
Validate whether the user's API Key is legitimate.
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 RequestId in the response can be used for tracing and troubleshooting issues.

URL Path

/api/v1/Authentication

Request method

POST

Request headers

Content-Type: application/json

Input Parameter

Parameter Name
Type
Required
Description
ApiKey
string
Yes
User API Key
UserId
string
Yes
User ID

Response data type

JSON

Sample response

{
    "code": 0,
    "data": {
        "Response": {
            "Result": true,
            "UserId": "********"
        }
    },
    "message": "ok",
    "requestId": "824f1198-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.
Result (boolean): Verification result, true indicates verification passed, false indicates verification failed.
UserId (string): User ID.
message (string): Response message.
requestId (string): Request ID.