基础对接API

「基础对接API」是一个提供系统文件上传等基础管理API

对接流程

在 系统设置 → 接口设置 → 管理对接API 中，设置对接 Key，后续的所有接口需要将对接 Key 放在请求中。

有两种传递对接 Key 的方式：

1. 将 Key 放在请求头中，请求头的 Key 为 admin-api-key
2. 将 Key 放在请求体中，请求体的 Key 为 ADMIN_API_KEY

接口列表

• PING测试：/api/admin_api/ping
• 上传图片：/api/admin_api/upload/image
• 上传图片(临时)：/api/admin_api/upload/image_temp
• 上传文件：/api/admin_api/upload/file
• 上传文件(临时)：/api/admin_api/upload/file_temp
• 清除缓存：/api/admin_api/clear_cache

具体接口参数请查看接口文档

功能特性

• 统一的管理对接 API，供第三方系统或自建工具调用站点能力
• 对接 Key 支持请求头（admin-api-key）与请求体（ADMIN_API_KEY）两种传递方式
• 内置图片 / 文件上传（含临时上传）与 md5 去重，避免重复存储
• 提供连通性测试与清除缓存接口，便于部署后自检与运维

基础对接API
    对接方式
        请求头 admin-api-key
        请求体 ADMIN_API_KEY
    上传能力
        上传图片
        上传文件
        临时上传
        md5 去重
    运维能力
        PING 连通性测试
        清除缓存

使用场景

• 第三方系统向站点上传图片、附件
• 部署脚本或运维工具调用站点接口清理缓存
• 自建客户端接入站点能力时的连通性自检

其他接口

后台菜单

• 系统设置
• 系统设置 → 接口设置
• 系统设置 → 接口设置 → 管理对接API