Previous topicNext topic
 万捷网络验证系统在线帮助文档
Help > WebApi接口说明 >
使用说明

万捷网络验证系统提供的API接口几乎可以实现任何编程语言的对接,给您的程序添加强大的网络验证功能;

关于名称:在本网络验证系统中称为WebApi接口,意思是网络应用程序接口,网络中还有其他名称,如:远程js代码、远程API、网络函数、远程代码、服务器自定义算法等,实际功能概念相同。

API接口通信地址:http://服务器地址/api.php

数据提交形式:可以通过GET和POST两种形式向API接口提交数据,提交形式如下;

GET方式:http://服务器地址/api.php?name=接口名称&c1=软件编号1&c2=参数2&c3=参数3....

POST方式:http://服务器地址/api.php    POST:name=接口名称&c1=软件编号1&c2=参数2&c3=参数3....

提交数据形式:name=自定义接口名称,c1=软件编号,c2=参数2,以此类推(c1参数必须为软件编号)

返回的数据默认为UTF-8编码,如果需要返回GB2312编码数据可以直接在URL参数中增加&code= 1

使用语法: API接口的开发与编辑必须使用标准的PHP语法;

PHP 算数运算符:

 运算符  名称  例子  结果
 +  加法  1 + 2  3
 -  减法  3 - 1  2
 *  乘法  5 * 2 10
 /  除法  10 / 2  5
. 字符串相加 "a" . "b"  ab
 %

 模数

 10 % 4  2

 

内置加密算法(为了安全,禁止使用系统加密算法,请用下面的算法代替):

进制转换:code_jzzh([字符串],[0=加密,1= 解密])

如:code_jzzh("字符串",0) 会返回:E5AD97E7ACA6E4B8B2

code_jzzh("E5AD97E7ACA6E4B8B2",1) 会返回:“字符串”

RC4算法:code_rc4([密匙],[数据]) 将字符串进行RC4加密,解密被RC4加密的字节集

base64算法:code_bs64([数据],[0=编码,1=解码]),对应系统函数 base64_encode 和 base64_decode

URL编码:code_url([字符串],[0=编码,1=解码]),对应系统函数 urlencode 和 urldecode

编码转换:code_bmzh([字符串],[0=UTF8->GB2312 ,1= GB2312->UTF8])将字符串编码在UTF8和GB2312之间进行转换

其他加密算法请使用综合加密解密接口【encrys】

注意:

    1、接口名称只能为数字、字母、下划线组合,不可包含中文、全角符号和特殊字符;

    2、向接口提交的数据最好不要包含中文和特殊字符,否则可能会出现未知错误;

    3、修改代码之前,请先备份下正确的代码,以防修改错误之后可以恢复,也方便查找错误;

    4、使用自定义API接口之前,必须开启API接口使用权限,开启位置:管理中心》软件管理》软件列表》点击 查询按钮,在列表中点击 修改软件配置》修改软件配置 界面 的 选项设置界面的 API接口控制 选择 开启,然后保存;

    5、系统API接口不可以直接调用,必须在自定义API接口中嵌套使用,具体请见下方的(示例4);

    6、提交数据时的参数名称不需要与API接口的参数名称相同,接口名称为name,参数名称都是c1,c2,c3等这样的c开头的参数名称,第一个参数就是c1,第二个参数就是c2以此类推;

示例1:调用自定义接口 返回文本信息:

    接口名称:zdy_fhwb 参数数量:0

   GET调用方法:http://服务器地址/api.php?name=zdy_fhwb&c1=软件编号

    POST调用方法:http://服务器地址/api.php  POST:name= zdh_fhwb&c1= 软件编号

    返回结果:返回内容

   function  zdy_fhwb(){

    return '返回内容';

  }

 

示例2:调用自定义接口 返回字符串相加结果

     字符串相加,接口名称:zdy_zfcxj 参数数量:3

    GET调用方法:http://服务器地址/api.php?name=zdy_zfcxj&c1=软件编号&c2=B&c3=C

    POST调用方法:http://服务器地址/api.phpPOST:name=zdy_zfcxj&c1=软件编号&c2=B&c3=C 

    返回结果:ABC

function  zdy_zfcxj($c1,$c2,$c3){

    return $c1.$c2.$3;

}

 

示例3:调用自定义接口 返回数字相加结果

     数值相加,接口名称:zdy_szxj 参数数量:2

    GET调用方法:http://服务器地址/api.php?name=zdy_szxj&c1=软件编号&c2=6

    POST调用方法:http://服务器地址/api.php  POST:name=zdy_szxj&c1=软件编号&c2=6

    返回结果:11

    注意:这里返回的数据前面增加了(string)是为了把返回的数值数据转换成文本后返回,如果不加的话返回的数据会无法显示;
 

function  zdy_szxj($c1,$c2){

    return (string)$c1+$c2;

 }


示例4:调用系统接口扣点

    接口名称:zdy_koudian参数数量:5

    系统API接口名称:kd    参数:软件编号,用户账号,用户密码(一次MD5的),操作类型(0=扣点,1=查询),扣除点数

    GET调用方法:http://服务器地址/api.php?name=zdy_koudian&c1=软件编号&c2=用户密码&c3=用户密码&c4=操作类型&c5=扣除点数

    POST调用方法:http://服务器地址/api.php  POST:name=zdy_koudian&c1=软件编号&c2=用户密码&c3=用户密码&c4=操作类型&c5=扣除点数

     返回结果:用户剩余点数

     注意:系统API接口有很多,请在 API接口介绍 中查看每个接口的具体介绍,系统接口是套在自定义函数内部使用的,自定义函数名称[zdy_koudian],系统接口名称【kd】

function  zdy_koudian($rjbh,$user,$pass,$czlx,$ds){

 return kd($rjbh,$user,$pass,$czlx,$ds);

}

系统API接口在线介绍地址:http://服务器地址/api/apitest/api_test.php(用于介绍系统API接口)

自定义API接口在线测试地址:http://服务器地址/api/apitest/api.php (用于在线测试自定义API接口是否功能正常)