API文档
快速开始使用我们的API接口
快速开始
第一步：注册账号
访问注册页面创建账号，获取您的API密钥。
第二步：调用API
将API密钥添加到请求头中，即可开始调用API。
第三步：集成到你的项目
参考下方示例代码，将API集成到你的应用中。
认证方式
Header认证（推荐）
将API密钥放在请求头的 X-API-Key 字段中：
curl -X GET "https://api.xinmeng.com/v1/random-image" \
-H "X-API-Key: your_api_key_here"
Query参数认证
将API密钥作为URL查询参数传递：
curl -X GET "https://api.xinmeng.com/v1/random-image?api_key=your_api_key_here"
频率限制
为了保证服务质量，我们对API调用进行了频率限制。
- 免费用户： 每分钟100次，每日1000次
- VIP用户： 每分钟500次，每日10000次
限制信息会在响应头中返回：
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000
API列表
GET
随机二次元图片
/api/v1/random-image
获取随机二次元图片
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X GET "https://api.xinmeng.com/api/v1/random-image" \
-H "X-API-Key: your_api_key_here"
GET
随机一言
/api/v1/hitokoto
获取随机一言
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X GET "https://api.xinmeng.com/api/v1/hitokoto" \
-H "X-API-Key: your_api_key_here"
GET
二维码生成
/api/v1/qrcode
生成二维码
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X GET "https://api.xinmeng.com/api/v1/qrcode" \
-H "X-API-Key: your_api_key_here"
GET
天气查询
/api/v1/weather
查询天气
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X GET "https://api.xinmeng.com/api/v1/weather" \
-H "X-API-Key: your_api_key_here"
GET
IP地址查询
/api/v1/ip-query
查询IP归属地
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X GET "https://api.xinmeng.com/api/v1/ip-query" \
-H "X-API-Key: your_api_key_here"
POST
短链接生成
/api/v1/short-url
长链接转短链接
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_key | string | 必填 | 您的API密钥 |
响应示例
{
"code": 200,
"message": "success",
"data": {
"url": "https://example.com/image.jpg"
}
}
调用示例
curl -X POST "https://api.xinmeng.com/api/v1/short-url" \
-H "X-API-Key: your_api_key_here"
错误码
| 错误码 | 说明 |
|---|---|
| 200 | 请求成功 |
| 400 | 请求参数错误 |
| 401 | 未授权，API密钥无效 |
| 403 | 权限不足 |
| 429 | 请求过于频繁，已达到限制 |
| 500 | 服务器内部错误 |