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

一．概述

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

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

1.    广告展现方式

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

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

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

2.    广告框类型

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

广告框支持类型：

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

二．SDK植入流程

1.    注册并获取SDK

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

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

 

2.    获取网站Key

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

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

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

3.    显示验证码

1）在YinXiangMaLocalConfig.php文件中找到如下代码做相应的配置，将第二步得到的两个Key在这里设置，还需要设置另外两个参数，这几个参数的含义及作用在该php文件中有详细解释：

define("PRIVATE_KEY","这里配置您的PRIVATE_KEY");

define("PUBLIC_KEY","这里配置您的PUBLIC_KEY");

define("LOCALSECURL","这里配置印象码应急策略的路径");

define("ISAJAX","1");

2）在您需要显示印象码的页面上方，添加如下代码，将我们的类库包含到您的文件中：

<?php  require_once("YinXiangMaLib.php"); ?>

3）然后在页面中合适的位置，添加如下代码，以便在该位置显示印象码：

<?php echo YinXiangMa_GetYinXiangMaWidget(); ?>

4.    校验结果

在您的PHP校验页面代码中，首先添加我们的类库，然后您可以调用我们封装的函数进行校验，代码如下：

<?php

require_once("YinXiangMaLib.php");

$YinXiangMa_response=YinXiangMa_ValidResult(@$_POST['YinXiangMa_challenge'],@$_POST['YXM_level'][0],@$_POST['YXM_input_result']);

if($YinXiangMa_response == "true") { echo "Yes!";}

else { echo "No!";}

?>

三．样例程序使用说明

1.     将PHP的SDK压缩包中的YinXiangMa_PHP_SDK_Demo文件夹放在网站根目录下

2.     访问demo的Login.php，比如http://127.0.0.1/YinXiangMa_PHP_SDK_Demo/Login.php即可看到印象码的demo展示效果，输入验证码后，点击校验，就可看到校验的结果。

 

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