API接口使用指南(基础篇)

一、什么是API接口

API(Application Programming Interface)是应用程序接口,允许开发者通过代码调用平台功能,实现自动化操作。

二、API接口的作用

• 批量生成短链接

• 自动创建单页

• 集成到第三方系统

• 开发自定义应用

• 实现自动化流程

三、API接口功能

吉利屋提供以下API接口:

1. 短链接生成API

2. 防红链接API

3. 单页生成API

4. 用户信息API

5. 订单查询API

四、如何开通API

步骤1:登录后台

进入用户后台首页

步骤2:开启API权限

1. 在账户信息区找到"API权限"

2. 点击"开启API"按钮

3. 阅读API使用协议

4. 确认开通

步骤3:获取API密钥

1. 开通后显示API密钥

2. 复制保存密钥

3. 密钥用于接口调用验证

步骤4:阅读API文档

1. 点击"API接口文档"

2. 查看接口说明

3. 了解调用方式

4. 查看返回格式

五、API调用基础

请求方式

• GET请求:获取数据

• POST请求:提交数据

请求地址

API基础地址:https://jili5.cn/api/

请求参数

• key:API密钥(必填)

• 其他参数根据接口不同

返回格式

JSON格式:

{

    "code": 200,

    "msg": "success",

    "data": {

    // 具体数据

    }

}

六、API调用示例

PHP示例

$key = 'your_api_key';

$url = 'https://jili5.cn/api/shorturl.php';

$data = [

    'key' => $key,

    'url' => 'https://example.com/long-url'

];

$response = file_get_contents($url . '?' . http_build_query($data));

$result = json_decode($response, true);

if ($result['code'] == 200) {

    echo '短链接:' . $result['data']['shorturl'];

} else {

    echo '错误:' . $result['msg'];

}

?>

JavaScript示例

const key = 'your_api_key';

const url = 'https://jili5.cn/api/shorturl.php';

fetch(`${url}?key=${key}&url=https://example.com/long-url`)

    .then(response => response.json())

    .then(data => {

    if (data.code === 200) {

    console.log('短链接:', data.data.shorturl);

    } else {

    console.log('错误:', data.msg);

    }

    });

Python示例

import requests

key = 'your_api_key'

url = 'https://jili5.cn/api/shorturl.php'

params = {

    'key': key,

    'url': 'https://example.com/long-url'

}

response = requests.get(url, params=params)

result = response.json()

if result['code'] == 200:

    print('短链接:', result['data']['shorturl'])

else:

    print('错误:', result['msg'])

七、返回代码说明

| 代码 | 含义 | 说明 |

|------|------|------|

| 200 | 成功 | 请求成功处理 |

| 400 | 参数错误 | 请求参数有误 |

| 401 | 认证失败 | API密钥错误 |

| 403 | 权限不足 | 无权限调用 |

| 429 | 请求过多 | 超出频率限制 |

| 500 | 服务器错误 | 服务器内部错误 |

八、API安全

密钥保护

• 不要泄露API密钥

• 不要在客户端暴露密钥

• 定期更换密钥

• 使用HTTPS传输

调用限制

• 注意频率限制

• 避免恶意调用

• 合理控制并发

• 做好错误处理

九、常见问题

Q: API调用有限制吗?

A: 有频率限制,具体查看API文档

Q: API密钥泄露怎么办?

A: 立即在后台重置密钥

Q: API返回错误怎么处理?

A: 根据返回代码排查问题

Q: 可以免费使用API吗?

A: 基础API免费,高级功能可能需要付费

---

下一篇:API接口使用指南(进阶篇)