本文档为CansCode API管理系统使用手册,适用于系统管理员、运营人员及接口维护人员。文档聚焦系统日常操作与配置的核心场景,涵盖模板管理、界面个性化设置、接口开发与添加、常见问题解决等关键内容。具体包括系统模板路径查询、站点背景与默认头像修改、页脚配置方法、本地及外部接口的添加流程、后台登录验证时长调整、首页展示数量修改等实用指引,同时提供了发布文章报错、API文档起始值修改、日志地址查询等问题的解决方案。通过本文档的详细步骤说明,用户可快速掌握系统各项基础操作与配置技巧,高效完成日常运维与接口管理工作。

系统模板地址

系统模板存放目录:

{目录}/Resource/Template

站点顶部背景

建议比例:19:7

默认头像修改

操作步骤:进入宝塔,前往系统以下目录

/Public/Uploads/Images/
目录下文件说明:
  1. UserAvatar.png 为用户默认头像
  2. MerAvatar.png 为商户默认头像
  3. UserBack.png 为默认背景图片

页脚设置方法

配置路径:前往路径 /admin/Temp/info/default 进行配置即可

相关截图:

canscodeAPI使用文档

本地接口开发教程

一、存放路径

Api文件存放于以下路径:

/Logic/API/

二、获取参数

即自己可以直接获取GET或POST请求,系统并未进行二次处理和拦截,可以直接获取

三、输出方式

可以使用echo、var_dump等方式进行输出,输出前可以自己定义相应头,示例代码:

<?php

// 文件路径示例:/Logic/API/test.php

// 设置响应头,声明返回 JSON 格式(可根据需求调整)
header('Content-Type: application/json; charset=utf-8');

// 获取 GET 参数,例如 ?name=liuhaonan
$getParams = $_GET;

// 获取 POST 参数
$postParams = $_POST;

// 组合数据,方便调试输出
$response = [
    'method' => $_SERVER['REQUEST_METHOD'],
    'get' => $getParams,
    'post' => $postParams,
];

echo json_encode($response);

注意事项:请勿使用exit或其他代码结束php进程,否则扣费逻辑将失效!

四、后台配置说明

  1. 若您的api接口代码存在/Logic/API/test.php,则后台《文件路径》中填写test.php
  2. 若您的api接口逻辑是一个文件夹,包含多个php文件,路径为:/Logic/API/test/xxx
  3. 入口文件为index.php,则后台《文件路径》中填写/Logic/API/test/index.php 或Logic/API/test均可

发布文章报错

解决方案:请关闭ningx防火墙

相关截图:canscode

怎么修改后台登录验证时长

  1. 打开宝塔
  2. 找到网站使用的PHP的设置
  3. 在php配置文件中修改以下内容:
session.gc_maxlifetime = xxxx        ; 代表 session 数据在服务器端保存xxx秒
session.cookie_lifetime = xxxx       ; 代表浏览器中的 session cookie 也保存xxxx秒

修改前端首页展示数量

打开文件

Resource/Template/default/index.php

修改内容

$_GET['pagesize'] = xx;/* 获取API列表展示数量*/
$_GET['pagesize'] = xx;/* 获取商户列表展示数量*/

添加一个外部接口


示例:

https://api.zijh.com/api/6tu?token=key&type=302

拆分规则

源站地址:以?作为分割

https://api.zijh.com/api/6tu
参数:以?或&进行分割一行一个
token=key
type=302

隐藏参数

在需要隐藏的参数行“是否可见”设置为“不可见”

小妙招

  1. 将示例输入apifox
  2. 调试测试没问题后
  3. 点击批量编辑
  4. 选择冒号模式
  5. 回到canscdeo系统搭建的网站
  6. 粘贴就好了

本地添加一个接口

填写文件路径

  1. 文件路径为某某文件夹里面的index.php需要填到具体的:xxx/index.php
  2. 文件路径为文件的直接添加文件名即可
  3. 参数依旧是一行一个
  4. 注意事项:本地文件需要放在:Logic/Api/文件夹下

API文档起始修改

操作方法:执行sql语句

ALTER TABLE xu_api AUTO_INCREMENT = xxx;
说明:xxx代表下一个开始的数,不可为1

日志地址

日志存放地址:

Logic/Log/api/
温馨提示:默认显示当天的日志,为了防止文件过大,建议定期删除或换地方保存