二次开发接口

 

     南京康斯特网络科技有限公司推出的新版本《ComST宽带认证计费管理系统》,支持完善而全面的WEB-URL 接口,允许购买客户使用Web-URL接口,自己可以进行二次开发。用户利用Web-URL接口可以实现以下几个目的:   

1、可以与任何第三方系统整合对接。

2、用户可以开发出自己的WEB管理界面。

3、可以实现让ComST系统成为第三方系统的一个无缝组成部分。

 

《ComST WebUrl接口规范说明手册》,购买用户可联系南京康斯特网络科技有限公司获取。该手册南京康斯特网络科技版权所有,并保留所有权利。以下是接口规范手册中部分开头说明,作为示例。

 

 

ComST Web-Url接口原理说明

1.1 概述

1、接口概述 
   WEB-URL接口,是指浏览器通过WEB URL携带一些命令参数,让服务器执行指定操作或
   返回需要的信息。  
2、URL命令参数格式 采用了标准URL命令参数格式,具体规则如下: 参数采用值名对格式,
   名和值用等号分隔,多个参数之间用&分隔,举例如下: 
   status=manage&opt=dbcs&dbName=usermanage_umb  
3、URL命令参数的交互方式 通过HTTP GET或POST命令,提交带URL参数的数据包到服务器。例如: 
 GET命令举例: 
  GET comstserver.awm?  
  status=manage&opt=dbcs&dbName=usermanage_umb&subopt=record&account=acc2
  &byName=true  HTTP/1.1   

  POST命令举例: 
  POST comstserver.awm HTTP/1.1  ........ ......... 
  status=manage&opt=dbcs&dbName=usermanage_umb&subopt=record&account=acc2 
  &byName=true   

4、交互过程说明
   采用标准HTTP交互方式,客户机用HTTP协议携带URL命令参数,提交到WEB服务器,
   服务器收到后,解析命令参数,并执行相应的操作,然后返回结果给客户机,客户机根据收到的结
   果,向用户界面显示相关信息。(注:客户机可以是浏览器,也可以是支持HTT协议的特殊客户端
   软件) 浏览器可以采用ajax或表单方式,直接提交URL参数。  
5、认证说明 
   必须先经过管理员认证后,才能进行Web-URL接口操作,否则将服务器将自动禁止操作。
   所以,在使用Web-URL之前,应先进行管理员认证,然后再进行各种URL接口调用。  

6、版本兼容性 本文挡规范描述的内容仅适合2014年2月以后推出的最新版本ComST系统。   


1.2 基本规则说明

1、支持利用任何WEB工具调用WEB-URL接口开发。 
2、完全兼容WEB专业开发工具extjs的数据格式,返回的json数据可直接被extjs使用。
3、URL参数大小写无关。 
4、URL页面后缀必须awm,例如comstserver.awm,名称随意。awm是康斯特自主研发

  的WEB解析引擎,它能自动解析康斯特公司定义的全部命令参数。 
5、服务器响应操作成功时,返回HTTP的代码都是200 OK,具体内容都用json结构返回。 
6、json结构的基本定义:    
   服务器返回的json结构内必定包含一个success属性,其值为true或false,浏览器端的
   javascript就是利用该success属性来判断是否成功或失败,若success=true,则表示成功,
   若为false,则表示失败。在Json结构中,可以增加其它用户自定义字段,浏览器端可以采用 
   javascritp直接用第二个参数action.response.responseText获得全部Json数据信息,
   然后转换成json对象,对其中成员进行操作。
   服务器响应的Json结构规定格式如下:  

     {     

            success: true,  //标准规定字段    

            data:{…}    //用户自定义字段 

      } 
7、返回错误信息格式的控制:    
 (1)COMST系统允许浏览器控制返回的错误信息格式,具体采用web-url参数err字段控制。    
 (2)err=json表示返回json格式,此时返回HTTP 200响应,消息体中带有以下json错误格式:    {"success":false,"Info":"操作失败,请检查!"}       

   :Info字段描述了为操作失败的具体原因,可提取向用户显示提示信息。 

 (3)若不带err字段,则表示用HTTP 403代码返回错误信息,消息体中直接包含了错误提示信息。

8、认证说明: 必须先经过管理员认证后,才能进行Web-URL接口操作,否则将服务器将自动禁止操
   作。所以,在使用Web-URL之前,应先进行管理员认证,然后再进行各种URL接口调用。

 

    联系我们

销售咨询:025-86640423
技术支持:025-86640419
   公司联系微信
           
  产品中心 服务支持 商业合作 关于我们 联系我们
           
  宽带认证计费管理系统 客服电话 OEM合作 公司概况 市场部:025-86640423
  PPPoE认证路由器 二次开发接口资料 渠道政策 人才招聘 技术部:025-86640419
  无线认证计费网关 资料下载 合作伙伴 法律声明 官方微信:
 

Radius认证计费系统

       
           
版权所有@ 南京康斯特网络科技有限公司   工信部认证|苏ICP备05024346号