📘 API 接口文档

本系统提供标准 RESTful API 接口,用户通过 AppID 和 AppKey 进行鉴权。

通用说明

请求方式:POST(推荐)或 GET

统一入口:/api/{接口名称}

返回格式:JSON

鉴权方式:AppID + 签名验证

签名算法

1. 将请求参数按 key 排序(排除 sign 参数)

2. 拼接为 key1=value1&key2=value2&app_key=YOUR_APP_KEY

3. 对上述字符串计算 MD5,即为签名 sign

function sign($params, $appKey) {
    ksort($params);
    $str = '';
    foreach ($params as $k => $v) {
        if ($k !== 'sign' && $v !== '') $str .= $k . '=' . $v . '&';
    }
    $str .= 'app_key=' . $appKey;
    return md5($str);
}

接口列表

POST /api/balance - 查询余额/剩余次数

必填参数:app_id, timestamp, sign

{"code":0,"msg":"ok","data":{"remain_calls":85,"expire_time":"2025-01-15"}}
POST /api/idcard - 身份证二要素核验

必填参数:app_id, name, idcard, timestamp, sign

{"code":0,"msg":"ok","data":{"result":"一致","name":"张三","idcard":"110101****1234"}}
POST /api/face - 人脸识别比对

必填参数:app_id, image_base64, name, idcard, timestamp, sign

POST /api/phone - 运营商三要素核验

必填参数:app_id, name, idcard, phone, timestamp, sign

错误码

错误码说明
0成功
401签名验证失败
402AppID不存在或应用已禁用
403次数不足
404套餐已过期
500系统内部错误
📦 SDK 下载

建议在您的后端集成SDK以保证AppKey安全。

下载 PHP SDK 下载 Python SDK

PHP 使用示例

require 'auth_sdk.php';
$sdk = new AuthSDK('https://your-domain.com', 'YOUR_APP_ID', 'YOUR_APP_KEY');
$result = $sdk->getBalance();
$result = $sdk->idcardVerify('张三', '110101199001011234');
print_r($result);
基本 文件 流程 错误 SQL 调试
  1. 请求信息 : 2026-06-30 20:20:01 HTTP/2.0 GET : https://face.chuliangnet.com/user/index/apiDoc
  2. 运行时间 : 0.867436s [ 吞吐率:1.15req/s ] 内存消耗:4,804.48kb 文件加载:140
  3. 缓存信息 : 0 reads,0 writes
  4. 会话信息 : SESSION_ID=2b12df24f0c6d89a639099e86ff69bd9
  1. /www/wwwroot/face.chuliangnet.com/public/index.php ( 8.42 KB )
  2. /www/wwwroot/face.chuliangnet.com/vendor/autoload.php ( 0.75 KB )
  3. /www/wwwroot/face.chuliangnet.com/vendor/composer/autoload_real.php ( 1.63 KB )
  4. /www/wwwroot/face.chuliangnet.com/vendor/composer/platform_check.php ( 0.90 KB )
  5. /www/wwwroot/face.chuliangnet.com/vendor/composer/ClassLoader.php ( 15.99 KB )
  6. /www/wwwroot/face.chuliangnet.com/vendor/composer/autoload_static.php ( 4.56 KB )
  7. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/helper.php ( 8.34 KB )
  8. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-validate/src/helper.php ( 2.19 KB )
  9. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/helper.php ( 1.47 KB )
  10. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/stubs/load_stubs.php ( 0.16 KB )
  11. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Exception.php ( 1.69 KB )
  12. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-container/src/Facade.php ( 2.71 KB )
  13. /www/wwwroot/face.chuliangnet.com/vendor/symfony/polyfill-mbstring/bootstrap.php ( 8.22 KB )
  14. /www/wwwroot/face.chuliangnet.com/vendor/symfony/polyfill-mbstring/bootstrap80.php ( 9.78 KB )
  15. /www/wwwroot/face.chuliangnet.com/vendor/symfony/var-dumper/Resources/functions/dump.php ( 0.99 KB )
  16. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-dumper/src/helper.php ( 0.18 KB )
  17. /www/wwwroot/face.chuliangnet.com/vendor/symfony/var-dumper/VarDumper.php ( 3.73 KB )
  18. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/App.php ( 15.30 KB )
  19. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-container/src/Container.php ( 15.76 KB )
  20. /www/wwwroot/face.chuliangnet.com/vendor/psr/container/src/ContainerInterface.php ( 1.02 KB )
  21. /www/wwwroot/face.chuliangnet.com/app/provider.php ( 4.15 KB )
  22. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Http.php ( 6.22 KB )
  23. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/helper/Str.php ( 7.29 KB )
  24. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Env.php ( 4.68 KB )
  25. /www/wwwroot/face.chuliangnet.com/app/common.php ( 34.89 KB )
  26. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/helper.php ( 18.77 KB )
  27. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Config.php ( 5.93 KB )
  28. /www/wwwroot/face.chuliangnet.com/config/app.php ( 6.43 KB )
  29. /www/wwwroot/face.chuliangnet.com/config/auth.php ( 0.25 KB )
  30. /www/wwwroot/face.chuliangnet.com/config/cache.php ( 4.64 KB )
  31. /www/wwwroot/face.chuliangnet.com/config/cloud.php ( 4.33 KB )
  32. /www/wwwroot/face.chuliangnet.com/config/console.php ( 3.92 KB )
  33. /www/wwwroot/face.chuliangnet.com/config/cookie.php ( 4.39 KB )
  34. /www/wwwroot/face.chuliangnet.com/config/database.php ( 10.36 KB )
  35. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/facade/Env.php ( 1.67 KB )
  36. /www/wwwroot/face.chuliangnet.com/config/filesystem.php ( 6.20 KB )
  37. /www/wwwroot/face.chuliangnet.com/config/lang.php ( 6.12 KB )
  38. /www/wwwroot/face.chuliangnet.com/config/log.php ( 5.13 KB )
  39. /www/wwwroot/face.chuliangnet.com/config/middleware.php ( 3.97 KB )
  40. /www/wwwroot/face.chuliangnet.com/config/route.php ( 6.43 KB )
  41. /www/wwwroot/face.chuliangnet.com/config/session.php ( 4.43 KB )
  42. /www/wwwroot/face.chuliangnet.com/config/trace.php ( 4.01 KB )
  43. /www/wwwroot/face.chuliangnet.com/config/view.php ( 5.50 KB )
  44. /www/wwwroot/face.chuliangnet.com/app/event.php ( 4.43 KB )
  45. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Event.php ( 7.77 KB )
  46. /www/wwwroot/face.chuliangnet.com/app/service.php ( 3.96 KB )
  47. /www/wwwroot/face.chuliangnet.com/app/AppService.php ( 5.40 KB )
  48. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Service.php ( 1.64 KB )
  49. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Lang.php ( 7.35 KB )
  50. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/lang/zh-cn.php ( 13.70 KB )
  51. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/initializer/Error.php ( 3.31 KB )
  52. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/initializer/RegisterService.php ( 1.33 KB )
  53. /www/wwwroot/face.chuliangnet.com/vendor/services.php ( 0.15 KB )
  54. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/service/PaginatorService.php ( 1.52 KB )
  55. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/service/ValidateService.php ( 0.99 KB )
  56. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/service/ModelService.php ( 2.04 KB )
  57. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-trace/src/Service.php ( 0.77 KB )
  58. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Middleware.php ( 6.72 KB )
  59. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/initializer/BootService.php ( 0.77 KB )
  60. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/Paginator.php ( 11.86 KB )
  61. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-validate/src/Validate.php ( 63.20 KB )
  62. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/Model.php ( 23.55 KB )
  63. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/Attribute.php ( 21.05 KB )
  64. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/AutoWriteData.php ( 4.20 KB )
  65. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/Conversion.php ( 6.75 KB )
  66. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/DbConnect.php ( 5.16 KB )
  67. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/ModelEvent.php ( 2.33 KB )
  68. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/concern/RelationShip.php ( 28.30 KB )
  69. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/contract/Arrayable.php ( 0.09 KB )
  70. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/contract/Jsonable.php ( 0.13 KB )
  71. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/model/contract/Modelable.php ( 0.09 KB )
  72. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Db.php ( 2.88 KB )
  73. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/DbManager.php ( 8.52 KB )
  74. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Log.php ( 6.28 KB )
  75. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Manager.php ( 3.92 KB )
  76. /www/wwwroot/face.chuliangnet.com/vendor/psr/log/src/LoggerTrait.php ( 2.69 KB )
  77. /www/wwwroot/face.chuliangnet.com/vendor/psr/log/src/LoggerInterface.php ( 2.71 KB )
  78. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Cache.php ( 4.92 KB )
  79. /www/wwwroot/face.chuliangnet.com/vendor/psr/simple-cache/src/CacheInterface.php ( 4.71 KB )
  80. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/helper/Arr.php ( 17.45 KB )
  81. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/cache/driver/File.php ( 7.84 KB )
  82. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/cache/Driver.php ( 9.02 KB )
  83. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/contract/CacheHandlerInterface.php ( 1.99 KB )
  84. /www/wwwroot/face.chuliangnet.com/app/Request.php ( 4.76 KB )
  85. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Request.php ( 54.64 KB )
  86. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/traits/UrlHandler.php ( 6.05 KB )
  87. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/traits/DomainHandler.php ( 5.49 KB )
  88. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/traits/HttpMethodHandler.php ( 4.74 KB )
  89. /www/wwwroot/face.chuliangnet.com/app/middleware.php ( 4.24 KB )
  90. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Pipeline.php ( 2.61 KB )
  91. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-trace/src/TraceDebug.php ( 3.40 KB )
  92. /www/wwwroot/face.chuliangnet.com/app/middleware/SystemCheck.php ( 27.92 KB )
  93. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/middleware/SessionInit.php ( 1.94 KB )
  94. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Session.php ( 1.80 KB )
  95. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/session/driver/File.php ( 6.27 KB )
  96. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/contract/SessionHandlerInterface.php ( 0.87 KB )
  97. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/session/Store.php ( 7.12 KB )
  98. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Route.php ( 23.73 KB )
  99. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/RuleName.php ( 5.74 KB )
  100. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/Domain.php ( 2.53 KB )
  101. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/RuleGroup.php ( 22.41 KB )
  102. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/Rule.php ( 27.49 KB )
  103. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/RuleItem.php ( 9.78 KB )
  104. /www/wwwroot/face.chuliangnet.com/route/app.php ( 52.80 KB )
  105. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/facade/Route.php ( 4.70 KB )
  106. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/dispatch/Controller.php ( 4.74 KB )
  107. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/route/Dispatch.php ( 11.32 KB )
  108. /www/wwwroot/face.chuliangnet.com/app/controller/user/Index.php ( 229.15 KB )
  109. /www/wwwroot/face.chuliangnet.com/app/controller/user/UserBase.php ( 20.47 KB )
  110. /www/wwwroot/face.chuliangnet.com/app/BaseController.php ( 25.80 KB )
  111. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/facade/Session.php ( 1.79 KB )
  112. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/facade/Db.php ( 0.93 KB )
  113. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/connector/Mysql.php ( 5.73 KB )
  114. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/PDOConnection.php ( 53.74 KB )
  115. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/Connection.php ( 8.39 KB )
  116. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/ConnectionInterface.php ( 4.57 KB )
  117. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/builder/Mysql.php ( 16.58 KB )
  118. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/Builder.php ( 24.07 KB )
  119. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/BaseBuilder.php ( 27.50 KB )
  120. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/Query.php ( 15.97 KB )
  121. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/BaseQuery.php ( 45.13 KB )
  122. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/TimeFieldQuery.php ( 7.43 KB )
  123. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/AggregateQuery.php ( 3.26 KB )
  124. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/ModelRelationQuery.php ( 20.07 KB )
  125. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/ParamsBind.php ( 3.66 KB )
  126. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/ResultOperation.php ( 7.01 KB )
  127. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/WhereQuery.php ( 19.37 KB )
  128. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/JoinAndViewQuery.php ( 7.11 KB )
  129. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/TableFieldInfo.php ( 2.63 KB )
  130. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-orm/src/db/concern/Transaction.php ( 2.77 KB )
  131. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/log/driver/File.php ( 6.10 KB )
  132. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/contract/LogHandlerInterface.php ( 0.86 KB )
  133. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/log/Channel.php ( 3.89 KB )
  134. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/event/LogRecord.php ( 1.02 KB )
  135. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-helper/src/Collection.php ( 16.47 KB )
  136. /www/wwwroot/face.chuliangnet.com/app/view/user/index/apiDoc.html ( 4.79 KB )
  137. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Response.php ( 9.07 KB )
  138. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/response/Html.php ( 0.97 KB )
  139. /www/wwwroot/face.chuliangnet.com/vendor/topthink/framework/src/think/Cookie.php ( 6.06 KB )
  140. /www/wwwroot/face.chuliangnet.com/vendor/topthink/think-trace/src/Html.php ( 4.42 KB )
  1. CONNECT:[ UseTime:0.001294s ] mysql:host=127.0.0.1;port=3306;dbname=face_chuliangnet;charset=utf8mb4
  2. SHOW FULL COLUMNS FROM `yl_channel` [ RunTime:0.001527s ]
  3. SELECT * FROM `yl_channel` WHERE `status` = 1 [ RunTime:0.000865s ]
  4. SHOW FULL COLUMNS FROM `yl_system_config` [ RunTime:0.003719s ]
  5. SELECT * FROM `yl_system_config` [ RunTime:0.000749s ]
0.879398s