[开发文档]API接口开发接入系统教程

接口头部代码:

必须引用:

require_once($_SERVER['DOCUMENT_ROOT'].'/includes/common.php');

必填信息 – 统计、计费控制模块。

<?php
/* 头部重要插件 */
$directory = dirname(__FILE__);
$folderName = basename($directory);
$apikey = daddslashes($_GET['apikey']?? $_POST['apikey']);
// 实例化ApiHelper类
$apiHelper = new \lib\ApiHelper();
// 调用checkApiKey方法进行API密钥验证
$apiHelper->checkApiKey($apikey, $folderName);
/* 头部重要插件 */

此代码为获取系统接口数据表和用户数据表,放在头部,以此达到接口限制作用

状态码对应表如下

['code' => '100', 'msg' => '您的apikey值为空!']
['code' => '101', 'msg' => '您的apikey值不存在!']
['code' => '102', 'msg' => '当前来源地址不在白名单内!']
['code' => '103', 'msg' => '当前接口为实名认证后可用,请您先进行实名!']
['code' => '104', 'msg' => '当前接口为企业认证后可用,请您先进行企业认证!']
['code' => '105', 'msg' => '当前接口未通过审核或已停止运营!']
['code' => '106', 'msg' => '您的余额不足,请及时充值!']
['code' => '107', 'msg' => '您当前的接口免费期限已过期,请及时开通!']
['code' => '108', 'msg' => '您的点数包已过期,请及时续费!']
['code' => '109', 'msg' => '您的点数包已用完,请及时充值!']
['code' => '110', 'msg' => '您的账号已被封禁,不可使用任何接口!']

接口结束代码 – 可以写到你代码指定位置扣费:

站长对接时接入方式:

<?php
/* 结束重要插件 */
// 在接口成功之前调用updateUser方法
$apiHelper->updateUser($apikey, $folderName);
/* 结束重要插件 */
?>

开发者对接时接入方式:

<?php
/* 结束重要插件 */
// 在接口成功之前调用updateUsers方法
$apiHelper->updateUsers($apikey, $folderName);
/* 结束重要插件 */
?>

完整接口代码示例

<?php
require_once($_SERVER['DOCUMENT_ROOT'].'/includes/common.php');
/* 允许跨域请求,接口建议允许 */
header('Access-Control-Allow-Origin:*');
/* 返回内容类型,默认返回JSON */
header('Content-Type: application/json; charset=utf-8');
/* 允许请求方式,设置GET和POST */
header('Access-Control-Allow-Methods:Get,Post');

/* 头部重要插件 */
$directory = dirname(__FILE__);
$folderName = basename($directory);
$apikey = daddslashes($_GET['apikey']?? $_POST['apikey']);
// 实例化ApiHelper类
$apiHelper = new \lib\ApiHelper();
// 调用checkApiKey方法进行API密钥验证
$apiHelper->checkApiKey($apikey, $folderName);
/* 头部重要插件 */

// 获取type参数,优先从GET参数获取,若不存在则从POST参数获取
$type = daddslashes($_GET['type']?? $_POST['type']);

switch ($type) {
    case 'json':
        $apiHelper->updateUser($apikey, $folderName);
        json_format(['code' => '200', 'msg' => Yiyan()]);
        break;
    default:
        $apiHelper->updateUser($apikey, $folderName);
        echo Yiyan();
        break;
}
function Yiyan() {
    $file = @file("yiyan.txt");
    if (!$file) {
        die('无法读取yiyan.txt文件');
    }
    $arr = mt_rand(0, count($file) - 1);
    return trim($file[$arr]);
}
?>

此是一言接口的示例代码,仔细看好头部和结尾的接入方法,结尾这是站长的代码,开发者的换成开发者的即可

接口开发完后放置在根目录/api文件夹即可,例如你的一言接口开发完之后,放在yiyan文件夹内,将此文件夹放在根目录的api目录内即可,你的接口即为https://api.spiunet.com/api/yiyan/之后你的接口

© 版权声明
THE END
喜欢就支持一下吧
点赞15 分享
评论 抢沙发
头像
欢迎您留下宝贵的见解!
提交
头像

昵称

取消
昵称表情代码图片快捷回复

    暂无评论内容