← 返回文档

API 参考文档

基础信息

Base URL/api/v1
Content-Typeapplication/json
认证方式Bearer Token(可选)

接口列表

GET/health

健康检查接口,用于监控服务状态。

// Response
{
    "status": "ok",
    "version": "1.0.0"
}

GET/api/v1/ping

简单的连通性测试。

// Response
{
    "message": "pong"
}

GET/sdk/versions

获取各平台 SDK 版本信息。

// Response
{
    "android": {
        "version": "1.0.0",
        "min_sdk": 21,
        "target_sdk": 34,
        "download": "/sdk/android/mc-gateway-release.aar",
        "integration": "/docs/android"
    },
    "ios": {
        "version": "1.0.0",
        "min_ios": "13.0",
        "download": "/sdk/ios/UmcUgateway.xcframework.zip",
        "integration": "/docs/ios"
    }
}

POST/api/v1/report

上报设备/应用数据(示例,需根据业务实现)。

// Request
{
    "app_id": "your_app_id",
    "device_id": "unique_device_id",
    "data": {
        // 业务数据
    },
    "timestamp": 1703836800
}

// Response
{
    "code": 0,
    "message": "success"
}

错误码

Code说明
0成功
400请求参数错误
401未授权
404资源不存在
500服务器内部错误

OpenAPI 规范

下载完整的 OpenAPI 规范文件:openapi.yaml