如何接入 API 接口？

通过 API 将短链接能力集成到你的系统、应用或自动化工作流中。

1. API 适用场景

• 批量生成短链接，提升运营效率
• 与 CRM、营销平台、短信系统等自有系统集成
• 构建自动化工作流，实现链接动态管理

2. 接入前准备

在调用 API 之前，请确认已完成以下准备工作：

• 注册并登录小南短链账号
• 确认当前套餐支持 API 调用
• 进入「个人中心」的「MCP & API」标签页自助开通并获取 API Key
• 阅读官方 API 文档，了解接口地址和参数规范

3. 接入步骤

3.1 获取 API Key

进入「个人中心」，切换到「MCP & API」标签页，点击「创建 API Key」即可自助开通。请妥善保存密钥，避免泄露给无关人员。

3.2 了解鉴权方式

大多数接口通过请求头携带 API Key 进行鉴权。部分接口可能需要签名或 Token，具体方式请参照 API 文档。注意按需分配密钥权限范围。

3.3 调用接口

根据文档构造请求 URL 和参数。常用接口包括：创建短链、查询短链、修改短链、获取统计数据等。建议所有请求均通过 HTTPS 发起。

3.4 处理响应

解析返回的 JSON 数据，根据状态码判断请求是否成功。建议记录错误码和失败原因，便于后续排查。

4. 常见错误与处理

• 401 未授权：检查 API Key 是否正确、是否已启用、是否在有效期内
• 429 请求过频：降低调用频率，或申请提升 QPS 配额
• 400 参数错误：核对必填字段、数据格式和长度限制
• 404 短码不存在：确认短码拼写正确且属于当前账号

5. 最佳实践

• 将 API Key 存储在服务端，避免在前端代码中暴露
• 对异常响应实现重试和指数退避机制
• 记录关键调用日志，便于审计和排错
• 定期轮换密钥，降低泄露风险

6. 常见问题