PHP SDK 接入教程:10 分钟调通第一个接口

用 PHP 调用 YesApi 接口的完整教程:从安装、签名算法、发起请求到错误处理,附可运行示例代码。

免费试用 YesApi Pro 查看全部定价 →
最后更新:2026-07-20作者:YesApi Pro 团队 · 广州果创网络科技 SDK接入
核心结论:PHP 接入 YesApi 三步走:①按「参数值排序拼接 + app_secret 后 MD5 大写」生成 sign;②POST 到 HOST/?s=服务名,带 s/app_key/sign;③判断返回 ret==200 再取 data。下方有 PHP 完整示例代码。
目录
⭐ 编辑推荐

想要自己的 API 平台?

YesApi Pro 私有部署后,用同样的 SDK 方式接入你自建的接口——源码交付、当天上线。

一、准备与安装

YesApi 官方提供 PHP SDK(YesApiPHPSDK.php),无需 Composer,直接引入即可;仅依赖 PHP 的 curl 扩展。

# 确认已开启 curl 扩展
php -m | grep curl

# 将 YesApiPHPSDK.php 放入项目,直接 require 引入

二、签名算法(核心)

YesApi 接口用签名(sign)防篡改,算法固定:把参数按 key 升序排序 → 拼接所有参数值(不含 key)→ 末尾追加 app_secret → MD5 → 转大写。各语言实现一致,务必与服务端保持相同规则。

<?php
// 签名:ksort 参数 → 拼接所有 value → 追加 app_secret → md5 → 大写
function yesapiSign(array $params, string $appSecret): string {
    ksort($params);
    $str = '';
    foreach ($params as $v) { $str .= $v; }
    return strtoupper(md5($str . $appSecret));
}

三、发起第一个请求

请求方式为 POST,地址为 HOST/?s=服务名,参数用 form 表单编码,需带上 sapp_key 与计算好的 sign。下面是 PHP 的完整可运行示例:

<?php
require 'YesApiPHPSDK.php';

// 方式一:用官方 SDK(推荐)
$rs = YesApiPHPSDK::request('App.Table.FreeQuery', [
    'model_name' => 'news',
    'page'       => 1,
    'perpage'    => 10,
]);
print_r($rs);

// 方式二:手写请求(理解底层)
$host = 'http://your-domain.yesapi.cn/';
$appKey = 'YOUR_APP_KEY';
$appSecret = 'YOUR_APP_SECRET';
$service = 'App.Table.FreeQuery';

$params = ['model_name' => 'news', 'page' => 1, 'perpage' => 10];
$params['s'] = $service;
$params['app_key'] = $appKey;
$params['sign'] = yesapiSign($params, $appSecret);

$ch = curl_init(rtrim($host, '/') . '/?s=' . $service);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
$res = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($res);

四、返回结构与错误处理

YesApi 统一返回 JSON:ret 为状态码(200 成功),data 为业务数据,msg 为错误信息。务必判断 ret 再取数据:

<?php
// 统一返回结构:ret=200 成功;data 为业务数据;msg 为错误信息
if (!empty($res) && $res['ret'] == 200) {
    $data = $res['data'];
    // 处理业务数据
} else {
    $msg = $res['msg'] ?? '请求失败或超时';
    error_log('YesApi error: ' . $msg);
}

五、上生产的几点建议

  • 密钥安全:app_secret 只放服务端,切勿写进前端/App 客户端
  • 超时与重试:设置合理超时(如 3-5s),对幂等接口做有限重试
  • 时间戳/随机串:如服务端要求,可加 timestamp/nonce 参与签名防重放
  • HTTPS:生产环境务必用 HTTPS,防止密钥与数据在传输中泄露
YesApi PHP Pro 标准版
¥15,899/套·永久
含基础功能·低成本启动
查看方案
旗舰版
¥23,899/套·永久
含API计费商城·多商户管理
查看方案
多商户版
¥38,899/套·永久
含完整源码·API市场
立即购买

搭建你自己的 API 平台

YesApi Pro 支持 PHP/Java 双版本、私有部署、源码交付,接入方式与本教程完全一致。

立即预约演示 →

常见问题

Q:PHP 调用签名总是错误怎么办?

99% 是签名规则不一致:确认①参数按 key 升序排序 ②只拼接「值」不拼 key ③末尾追加 app_secret ④结果转大写。参数值需与最终发送的一致(含 s、app_key)。

Q:app_key 和 app_secret 从哪来?

在 YesApi Pro 管理后台创建应用后获得。app_key 用于标识身份,app_secret 用于签名,务必只存服务端。

Q:请求用 GET 还是 POST?

推荐 POST,参数用 form 表单编码提交到 HOST/?s=服务名。POST 更安全,也避免 URL 长度限制。

Q:YesApi Pro 私有部署后接入方式一样吗?

一样。私有部署只是把 HOST 换成你自己的域名,签名算法与调用方式完全一致。Java 旗舰版 ¥33,800 起、PHP 标准版 ¥15,899 起。

继续阅读:更多 API 选型指南