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

NetCMS
API开发商接口文挡
API标识ID及公共接口规范
权限接口规范
通用标签接口规范
发布站点接口规范
标签接口规范
会员积分接口规范
导航菜单接口规范
会员权限控制
插入评论
插入收藏
总体说明:
CMS时使用,请开发商按照以下接口规范使用
API标识ID及公共接口
API的传送参数标识ID需要用户自己定义,可以定义任意不为0的ID。如:job001,尽量建立得复杂些,以避免和别的API标识ID重复,最大长度30字符。不允许为中文,只能为英文,数字及下划线
插入公共数据库:NT_API_Ident, 此表存在于主数据库中
数据库设计
NT_API_ Ident 数据库结构如下
字段名
长度
说明
备注
API_ID
Int(4) (not null)
自动编号
主键
API_Name
Varchar(50) (not null)
API系统名称
第三方API商开发的系统名称,如:供求系统
API_Ident
Varchar(30) (not null)
API标识ID
API的唯一标识ID
API_ManageDir
Varchar(30) (not null)
API后台安装目录
路径为: /Manage/配置文件里API目录(后台)/您创建的目录
API_ ProsDir
Varchar(30) (not null)
API前台安装目录
路径为/配置文件里API目录(前台)/您创建的目录
API_ParamPath
Varchar(200) (not null)
API系统的参数设置
用于在主站参数设置中进行连接
Api_Rec_Label
Varchar(200) (not null)
接受传递的参数
作用:主系统在模板中查询到了标签属于API的。则把标签传递给此文件
格式:?Label=传递过来的标签的加密串
此文件必须要加密,否则将对系统有安全隐患。
Api_DataSource
Ntext (null)
数据库连接字符串
为空则为主数据连接
Api_DataType
Varchar(20)
连接对象
Api_passCode
Varchar(30)
加密串
用于参数传递使用。
API商只需要通过程序把API数据插入此表中既可
权限接口
API权限公共库表名NT_API_POP, API开发商需要把功能的权限代码加入到此数据库表中。此表存在于主数据库中
数据库设计
NT_API_ POP 数据库结构如下
字段名
长度
说明
备注
pop_ID
Int(4) (not null)
自动编号
主键
api_IdentID
Varchar(30) (not null)
API系统标识ID
API系统标识ID,主系统为0
Pop_classid
int
权限标识编号
不能重复。范围为: 1000-2000,只能为数字,系统自动生成
pop_parentID
int
父权限标识编号
pop_Name
Varchar(50) (not null)
具体权限代码名称
小于50个字符
pop_PopID
Varchar(10