基本信息

API基本信息

• 接口地址：https://api.spell.im
• 接口存在版本号
  • 使用：https://api.spell.im/v1
  • 文档：请在左上角切换至对应的API版本

构造请求

接口可能需要用户的 API Key 或签名，如果还没有创建，请先创建 API Key。

• 请求头中均需包含：X-API-Key: <ApiToken>
• GET 查询操作中，参数在URL中携带发送，即 Query Parameters；
• POST 创建操作中，参数在请求体中发送，格式为 application/json，请求头中需要包含签名X-Signature: <SIGNATURE>，具体请参考：API密钥。

获取响应

所有接口的响应都是 JSON 格式。

响应返回状态码

• HTTP 200：成功
• HTTP 400：请求错误
• HTTP 401：未认证
• HTTP 403：无权限
• HTTP 404：资源不存在
• HTTP 500：服务器错误

对于成功的请求，常见的返回形式如下：

单结果数据，如创建成功后的返回：

{
    "code": 200,
    "data": { 
        // 单条数据
    }
}

多结果数据，如查询列表返回：

{
    "code": 200,
    "items": [
        {
            // 单条数据
        },
        {
            // 单条数据
        },
        ...
    ]
}