使用指南

API调用流程(5步完成)

1

注册并登录账号

访问注册页面,填写手机号/邮箱完成注册,然后通过登录页面进入系统。

建议使用常用手机号注册,便于接收验证码和账号通知。
2

获取API密钥(API Key)

登录后进入「个人中心」→「API密钥管理」页面,点击「生成密钥」按钮,系统将自动生成一对Access Key(访问密钥)和Secret Key(密钥密码),请妥善保存(Secret Key仅显示一次)。

API密钥是调用接口的重要凭证,请勿泄露给他人,若怀疑泄露请及时在页面中「重置密钥」。
3

选择并了解目标API

回到首页,浏览或搜索需要的API(如「短信发送API」「图片压缩API」),点击进入API文档页,查看接口的请求地址、参数说明、返回格式及调用示例。

注意区分「免费API」和「收费API」,收费API需先在「个人中心→充值」页面充值后才能调用。
4

集成API到项目中

根据API文档中的示例代码,在您的项目中编写调用逻辑。所有接口需在请求头中携带「Authorization」参数,格式为:Authorization: YOUR_ACCESS_KEY:YOUR_SIGNATURE(Signature为请求参数+Secret Key的签名值,具体签名规则见API文档)。

// PHP调用示例(以短信发送API为例) $accessKey = "your_access_key"; $secretKey = "your_secret_key"; $url = "https://api.denglong.com/sms/send"; // 请求参数 $data = [ "phone" => "13800138000", "content" => "您的验证码是:123456,5分钟内有效" ]; // 生成签名(具体规则见API文档) ksort($data); $signStr = http_build_query($data) . "&secret_key=" . $secretKey; $signature = md5($signStr); // 发起请求 $headers = [ "Authorization: " . $accessKey . ":" . $signature, "Content-Type: application/x-www-form-urlencoded" ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data)); curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); // 处理返回结果 $result = json_decode($response, true); if ($result["code"] == 200) { echo "调用成功,短信ID:" . $result["data"]["sms_id"]; } else { echo "调用失败:" . $result["msg"]; }
5

测试与调试

完成集成后,先发起测试请求,查看返回结果。若返回「200」状态码表示调用成功;若返回错误码(如401、403、500),可根据返回的「msg」字段提示排查问题(或参考下方「常见问题」)。

可在「个人中心→API调用记录」页面查看所有调用日志,便于调试和问题定位。

常见问题(FAQ)

调用API时返回「401 Unauthorized」是什么原因?
通常是API密钥验证失败,可能原因:1. Access Key不存在或已失效;2. Signature签名错误(检查参数排序、Secret Key是否正确);3. 请求头中「Authorization」参数格式错误。建议重新核对密钥和签名逻辑。
收费API调用失败,提示「余额不足」,但我已经充值了怎么办?
首先在「个人中心→账户余额」页面确认余额是否到账(充值后可能有1-2分钟延迟);若余额正常,检查该API的「单次调用价格」是否超过剩余余额;若仍有问题,可联系客服(api@example.com)核查。
如何查看API的调用记录和消耗明细?
登录后进入「个人中心」,可在「API调用记录」页面查看所有接口的调用时间、状态、消耗金额;在「账单明细」页面可查看充值、扣费的详细记录,支持按时间范围筛选。
API返回「500 Internal Server Error」,该如何处理?
这是服务器内部错误,通常不是您的调用问题。建议:1. 先检查API文档是否有临时维护通知;2. 间隔1-2分钟后重新尝试调用;3. 若多次调用仍失败,记录调用时间、请求参数并联系客服,我们会尽快排查修复。
可以同时生成多个API密钥吗?如何管理不同环境的密钥?
支持生成多个API密钥,您可以在「个人中心→API密钥管理」页面点击「生成密钥」创建新密钥,并为每个密钥设置备注(如「测试环境密钥」「生产环境密钥」)。需要禁用某密钥时,点击「禁用」按钮即可,禁用后该密钥无法再调用接口。

注意事项

API密钥具有极高权限,请勿在客户端代码(如前端JS、APP客户端)中直接暴露,建议通过您的后端服务器转发API请求,避免密钥泄露。
每个API都有调用频率限制(如「短信发送API」每分钟最多调用10次),具体限制在API文档中说明,超过限制会返回「429 Too Many Requests」,请合理控制调用频率。
免费API仅供测试和小型项目使用,调用量有上限(如每天100次),如需更高调用量,请升级为收费套餐或联系客服定制方案。
请确保调用API时的参数格式正确(如手机号需为11位数字、图片文件大小不超过5MB),参数错误会返回「400 Bad Request」,具体错误信息可查看返回的「msg」字段。
若您的账号存在恶意调用API(如发送垃圾短信、频繁请求无效参数),系统会自动封禁账号和API密钥,且不予解封,请遵守API使用规范。