YinXiangMa_SDK_For_Java_V2.0接口开发者使用说明

一．概述

此文档旨在指导Java网站主如何在自己的网站中植入印象码。

作为Java网站的开发者，仅需要在网站后台进行简单的配置，就可以轻松地在您所搭建的网站上使用印象码，在使用安全、用户体验良好的验证码的同时，也为网站主带来可观的收入。

1.    广告展现方式

印象码目前有两种形式的广告类型：嵌入式广告（推荐）和弹出式广告。

嵌入式广告：印象码广告框与网站融为一体，网站主可以设定印象码广告框大小、颜色等样式。

弹出式广告：在网页点击文本框时，弹出印象码广告框。

2.    广告框类型

印象码现在有三种类型：iPad形、液晶形、弹出框。

广告框支持类型：

	iPad形	液晶形	弹出框
嵌入式	支持	支持	不支持
弹出式	不支持	不支持	支持

二.SDK植入流程

1.    获取网站Key

1） 请访问http://www.yinxiangma.com注册网站主帐户并等待审核。

2） 审核通过后，登陆印象码广告平台，点击右上角的，然后选择下载PHP版本的SDK压缩包，里面包括两个封装好的SDK文件：YinXiangMaLib.php、YinXiangMaLocalConfig.php，压缩包里还有印象码应急策略文件夹localsec以及样例程序的压缩包YinXiangMa_PHP_SDK_Demo.rar。

3） 登陆印象码广告平台，点击，然后，根据提示完成站点的创建，包含三部分：选择验证码类型、站点基本信息设置、验证码外观设置。

4） 网站主登录后台，点击站点管理找到自己创建的站点。

 

5） 创建站点后，点击站点key即可看到如下图所示的页面，并且看到自己站点的key：

 

2.    显示验证码

在页面中需要放置验证码的位置添加如下代码：

<script type='text/javascript' charset='gbk'>

var YXM_PUBLIC_KEY = 'f619ca7d2ae0ff99e5727f697a6a2882';//这里填写PUBLIC_KEY

var YXM_isajax = '1';//这里设置是否使用ajax校验功能，1为使用，0为不使用，在样例程序中有示例参考

document.write("<input type='hidden' id='YXM_here' /><script type='text/javascript' charset='gbk' id='YXM_script' async src='http://api.yinxiangma.com/api2/yzm.yinxiangma.php?pk="+YXM_PUBLIC_KEY+"&m=live&v=YinXiangMaJavaSDK_2.0&a="+YXM_isajax+"&j=0'><"+"/script>");

</script>

2.    校验结果

1）将com.YinXiangMa.jar放在网站的编译路径lib下；

2）导入印象码jar包：

import com.YinXiangMa.*;

3）验证码校验：

String result = YinXiangMa.Check_Answer("这里填写PRIVATE_KEY", request.getParameter("YinXiangMa_challenge"), request.getParameter("YXM_level"), request.getParameter("YXM_input_result"));

if (result=="true"){ //校验正确后的操作 }

else{ //校验失败后的操作 }

三.样例程序使用说明

1.Java的SDK压缩包中，Demo_SDK_JSP_V2.0.rar为用myeclipse开发的简单的样例程序，并且有ajax校验的示例。请开发者参照。

 

SDK下载地址：http://www.yinxiangma.com/sdk/Java_2.0.rar