API文档

这是一份关于可用 API 端点的说明文档，所有端点均基于REST 架构构建。所有 API 端点均会返回带有标准HTTP 响应状态码的JSON 格式响应数据，且调用时需通过API 密钥进行承载式身份验证。

获取专属API密钥

基础URL

身份验证

所有 API 端点均需通过Bearer身份验证方式发送API密钥。

Authorization: Bearer {api_key}

示例

curl --request GET \
--url 'https://www.pmq.net/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

我们的API使用标准的HTTP状态码来指示请求是成功还是失败。

示例

{
    "errors": [
        {
            "title": "\u4f60\u6682\u65e0API\u8bbf\u95ee\u6743\u9650\u3002",
            "status": 401
        }
    ]
}

状态码

200 请求已成功完成

400 请求错误 —— 缺少必填参数或参数无效

401 未授权 —— API 密钥缺失或无效

404 未找到请求的资源

429 请求过多 —— 已超过速率限制

500 服务器内部错误 —— 这意味着是我们这边出了问题

除非另有说明，所有API端点返回的结果均使用UTC时区。

用户

二维码

条形码

链接

链接统计

自定义域名

团队

团队成员

账户日志