API接口文档-NETCMS网站内容管理系统

《API接口文档-NETCMS网站内容管理系统》由会员分享，可在线阅读，更多相关《API接口文档-NETCMS网站内容管理系统（5页珍藏版）》请在金锄头文库上搜索。

1、四川古羌科技发展有限公司 内部技术文档 请注意保密1NetCMS API 开发商接口文挡开发商接口文挡 API 标识 ID 及公共接口规范 权限接口规范 通用标签接口规范 发布站点接口规范 标签接口规范 会员积分接口规范 导航菜单接口规范 会员权限控制 插入评论 插入收藏 总体说明：总体说明：此文档为 API 商开发基于 NetCMS 时使用，请开发商按照以下接口规范使用 API 标识标识 ID 及公共接口及公共接口API 的传送参数标识 ID 需要用户自己定义，可以定义任意不为 0 的 ID。如：job001,尽量建立得复杂些， 以避免和别的 API 标识 ID 重复,最大长度 30 字符

2、。不允许为中文，只能为英文，数字及下划线 插入公共数据库:NT_API_Ident, 此表存在于主数据库中 数据库设计NT_API_ Ident 数据库结构如下字段名字段名长度长度说明说明备注备注API_IDInt(4) (not null)自动编号主键API_NameVarchar(50) (not null)API 系统名称第三方 API 商开发的系统名称，如：供求系统API_IdentVarchar(30) (not null)API 标识 IDAPI 的唯一标识 IDAPI_ManageDirVarchar(30) (not null)API 后台安装目录路径为: /Manage/配置

3、文件里 API 目录（后台）/您创建的目录API_ ProsDirVarchar(30) (not null)API 前台安装目录路径为 /配置文件里 API 目录（前台）/您创建的目录API_ParamPathVarchar(200) (not null)API 系统的参数设置用于在主站参数设置中进行连接Api_Rec_LabelVarchar(200) (not null)接受传递的参数作用：主系统在模板中查询到了标签属于 API 的。则把标签传递给此文件格式：sysPublic.aspx?Label=传递过来的标签的加密串此文件必须要加密，否则将对系统有安全隐患。Api_DataSour

4、ceNtext (null)数据库连接字符串为空则为主数据连接Api_DataTypeVarchar(20)连接对象四川古羌科技发展有限公司 内部技术文档 请注意保密2Api_passCodeVarchar(30)加密串用于参数传递使用。API 商只需要通过程序把 API 数据插入此表中既可权限接口权限接口API 权限公共库表名 NT_API_POP, API 开发商需要把功能的权限代码加入到此数据库表中。此表存在于 主数据库中数据库设计NT_API_ POP 数据库结构如下字段名字段名长度长度说明说明备注备注pop_IDInt(4) (not null)自动编号主键api_IdentIDV

5、archar(30) (not null)API 系统标识 IDAPI 系统标识 ID,主系统为 0Pop_classidint权限标识编号不能重复。范围为： 1000-2000,只能为数字,系统自动生成pop_parentIDint父权限标识编号pop_NameVarchar(50) (not null)具体权限代码名称小于 50 个字符pop_PopIDVarchar(10) (not null)权限的具体代码用于加入程序中使用。不能为 1000-2000 范围内的数字最大长度 10 个字符,使用得越复杂越好，以避免和其他权限代码重复。建议在权限代码前加一个API 商的标识符。如：NT00

6、0123 pop_ContentVarchar(200) (null)权限说明具体权限的帮助说明信息pop_StandbyVarchar(200) (null)备用字段备用字段Pop_addTimeDatetime创建日期说明 在 API 开发的程序后台中加入此 API 的权限代码，就可以方便的控制管理员权限了。权限的调用 1引入命名空间：NT.root.pop 2调用方式： 通用标签接口通用标签接口API 通用标签公共库表名 NT_API_Currency, API 开发商需要把功能的通用标签代码加入到此数据库 表中。此表存在于主数据库中 数据库设计NT_API_Currency 数据库结构

7、如下字段名字段名长度长度说明说明备注备注ac_IDInt(4) (not null)自动编号主键api_IdentIDVarchar(30) (not null)API 系统标识 IDAPI 系统标识 IDac_NameVarchar(20) (not null)通用标签的名称ac_CodeVarchar(200) (not null)通用标签的代码如 API=API的标识,NT_News_Title,请使用 API=API的标识,*格式。*代表具体的代码四川古羌科技发展有限公司 内部技术文档 请注意保密3 标签接口标签接口API 标签公共库表名 NT_API_LabelType, API

8、开发商需要把自己建立的标签代码加入到此数据库表中。 此表存在于主数据库中。此表为主数据库和 API 公共数据库,API 系统不能直接操作此表，需要传递参数给 主系统。由主系统进行操作。 数据库设计NT_API_LabelType 数据库结构如下字段名字段名长度长度说明说明备注备注sL_IDInt(4) (not null)自动编号主键api_IdentIDVarchar(30) (not null)API 系统标识 IDAPI 系统标识 ID,如果为主系统，则为 0sl_NameVarchar(20) (not null)标签的分类名称比如：终极类标签，列表类标签,常规类标签sl_FilePa

9、thVarchar(200) (not null)标签连接文件地址如 label/creat_List.aspx.连接地址相对于 API 的根目录sl_creatTimeDatetime(not null)标签创建日期说明 API 需要把自己建立的标签插入到主数据库中。但不能直接插入。需要传递参数给主系统。由主系统处理 并插入。 注意：sl_filePath 字段中的连接文件在点确定或者关闭页面时需要返回一个值（您需要创建的标签结果） ，主系统会把这个值插入模板中。 发布站点接口规范发布站点接口规范说明 此项规范为是主系统为替换模板中的标签而制作API 接收主系统传来的标签进行处理规范 见 A

10、PI 标识 ID 及公共接口的 Api_Rec_Label 字段说明 积分接口规范积分接口规范说明 用于为用户增加(减少)积分/G 币/数据统计调用 1. 引入命名空间：NT.root.userPoint 2. 调用方式会员权限控制规范会员权限控制规范说明 用于为用户增加(减少)积分/G 币/数据统计调用四川古羌科技发展有限公司 内部技术文档 请注意保密41 引入命名空间：NT.root.userpop 2 调用方式： 导航菜单规范导航菜单规范此功能为 API 开发后台/前台菜单整合接口。 数据库设计API 导航公共库表名 NT_API_Navi, API 开发商需要把自己建立的菜单代码加入

11、到此数据库表中。此表存在于主数据库中。NT_API_Navi 数据库结构如下字段名字段名长度长度说明说明备注备注am_IDInt(4) (not null)自动编号主键api_IdentIDVarchar(30) (not null)API 系统标识 IDAPI 系统标识 ID,如果为主系统，则为 0am_ClassIDVarchar(10)唯一的编号长度为 5-10 位, Am_positionVarchar(5)位置标志长度为 5 位,如果为 00000 则放到顶部如果为 99999，存放到下来菜单中，示范其他数据，则存放到左侧导航菜单中am_NameNvarchar(20) 菜单名称Am

12、_EnameNvarchar(20)菜单英文am_FilePathVarchar(200) (null)连接文件地址如 sys/News_List.aspx.连接地址相对于 API 的根目录am_targetVarchar(20) (null)打开窗口默认为 main,如：target=”main”am_ParentIDVarchar(10) (not null)父级菜单am_typeBit(1) (not null)菜单类型分为：后台(0)，前台(1) am_creatTimeDatetime (not null)创建日期am_orderIDint(null)排列序号数据越大，排越后isSy

13、sInt(1) (not null)是否是系统数据1 为是，0 为否默认数据：内容管理 位置标志：00000, 连接文件地址:menu.aspx?Type=10001 isSys 值：1通 行 证 位置标志：00000, 连接文件地址:menuaspx?Type=10002 isSys 值：1模板管理 位置标志：00000, 连接文件地址:menu.aspx?Type=10003 isSys 值：1发布管理 位置标志：00000, 连接文件地址:menu.aspx?Type=10004 isSys 值：1标签管理 位置标志：00000, 连接文件地址:menu.aspx ?Type=10005

14、 isSys 值：1系统插件 位置标志：00000, 连接文件地址:menu.aspx?Type=10006 isSys 值：1控制面板 位置标志：00000, 连接文件地址:menu.aspx?Type=10007 isSys 值：1API 管理 位置标志：00000, 连接文件地址:menu.aspx ?Type=10008 isSys 值：1四川古羌科技发展有限公司 内部技术文档 请注意保密5以上数据可以排序，但不能删除,可修改！ 新创建的 API，位置标志必须为 99999,插入评论插入评论 插入评论表： 表名：表名：NT_API_ commentaryIdint ()自动编号,主键

15、CommidNVarchar(12)评论编号InfoIDNVarchar(12)被评论的信息 IDAPIIDNVarchar(20)API 的标识TitleNVarchar(200)标题ContentNtext评论内容creatTimedateTime评论日期IPNvarchar(20)IP 地址QIDNvarchar(12)引用的评论编号UserNumVarchar(15)评论用户编号，如果匿名，则此显示 0插入收藏插入收藏 表名：表名：NT_API_ FaviateIdint ()自动编号,主键FIDNVarchar(12)收藏编号InfoIDNVarchar(12)被收藏的信息 IDUserNumNvarchar(15)用户编号CreatTimedateTime创建日期APIIDVarchar(20)API 的标识