API文档 - 小宇API

1. 引言

欢迎使用小宇API服务平台。本文档将帮助您了解如何使用我们的API服务，包括请求方式、全局错误码、认证方式等。

所有API请求均需要通过API密钥进行认证。您可以在用户中心获取您的API密钥。

GET请求

在GET请求中，您需要将API密钥作为URL参数传递：

示例：

GET /api/endpoint?apikey=YOUR_API_KEY¶m1=value1¶m2=value2

POST请求

在POST请求中，您可以通过两种方式传递API密钥：

示例1：URL参数

POST /api/endpoint?apikey=YOUR_API_KEY
Content-Type: application/json

{
    "param1": "value1",
    "param2": "value2"
}
                        

示例2：请求头

POST /api/endpoint
Content-Type: application/json
apikey: YOUR_API_KEY

{
    "param1": "value1",
    "param2": "value2"
}
                        

以下是API返回的常见错误码及其说明：

403 Forbidden

访问被拒绝：缺少必要的apikey参数或apikey无效

404 Not Found

接口不存在或已暂停服务

429 Too Many Requests

请求过于频繁，请稍后再试（超过QPS限制）

500 Internal Server Error

服务器内部错误，请稍后重试

402 Payment Required

余额不足，请充值后重试

-1

请求参数错误或无效

API响应格式通常为JSON，包含以下字段：

{
    "code": 200,
    "message": "请求成功",
    "data": {
        // 响应数据
    }
}
            

如果您在使用API过程中遇到问题，或有任何建议，欢迎通过以下方式联系我们：