边缘开发者平台
  • 边缘图片渲染
    • 产品简介
    • 快速入门
    • 开发指南
      • 简介
      • 签名 URL
      • API 生成
    • 开放 API
      • 简介
      • API 概览
      • 接口列表
        • 账号验证
        • 获取模板列表
        • 获取模板实例
        • 获取图片签名 URL
    • 常见问题
当前为国际站中文文档,如需访问中国站文档,请点击这里

账号验证

接口描述

接口请求域名:image.edgeone.app
验证用户 API Key 是否合法。
注意:
1. 所有接口都需要传 ApiKey + UserId 用于接口鉴权,API Key为您的私有密钥,请在调用 API 时避免泄露 API Key。
2. 响应中的 RequestId 可用于追踪和排查问题。

接口地址

/api/v1/Authentication

请求方法

POST

请求头

Content-Type: application/json

输入参数

参数名
类型
必填
描述
ApiKey
string
用户 API Key
UserId
string
用户 ID

响应数据类型

JSON

响应示例

{
"code": 0,
"data": {
"Response": {
"Result": true,
"UserId": "********"
}
},
"message": "ok",
"requestId": "824f1198-xxxx-xxxx-xxxx-xxxx"
}

字段说明

code (int): 响应状态码,0 表示成功。
data (object): 包含实际响应数据的对象。
Response (object): 实际的业务响应数据。
Result (boolean): 验证结果,true 表示验证通过,false 表是验证失败。
UserId (string): 用户 ID。
message (string): 响应消息。
requestId (string): 请求 ID。