snowshoe / stamp-sdk
SnowShoeStamp 客户端 SDK 库
3.0.3
2020-02-21 22:11 UTC
Requires
- php: >=7.2.0
This package is auto-updated.
Last update: 2024-09-22 11:31:17 UTC
README
这是一个 SDK 包,可以在 PHP 代码中使用插件的形式,将代表戳记点的正确编码字符串传输到 SnowShoe 服务器,并获取带有戳记信息的响应。
安装
您可以通过 Packagist 包 安装 snowshoe/stamp-sdk
。只需将以下行添加到您的 composer.json 文件中
"snowshoe/stamp-sdk": "3.*"
入门指南
-
要使用此 SDK 工具,您首先需要创建一个应用程序。您可以在 这里 学习如何操作
-
确保您获取到您将需要的 API 密钥来运行请求。您可以在 这里 了解更多关于 API 密钥的信息
-
传递给我们的服务器的戳记数据是一个包含 x,y 坐标的数组。这些代表您要获取数据的戳记的触摸点。如果您使用我们前端 jQuery 插件(更多信息请见 这里)来捕获戳记触摸点数据,那么您可以直接通过请求传递这些数据,无需更改。
测试页面
- 要创建一个测试页面,以确保 SnowShoe 插件已正确安装并且一切正常,我们首先需要包含 autoload.php 和用于传输的 SSSApiClient,如下所示
<?php
require "vendor/autoload.php";
use Snowshoe\SSSApiClient;
- 为了测试它是否可以正确发送和接收数据,我们将使用以下代码片段
$client= new SSSApiClient("INSERT_API_KEY");
$JSONResponse=$client->processData("[[264,172],[267,371],[242,286],[69,375],[66,221]]");
echo $JSONResponse;
?>
在这个测试示例中,您通过使用您之前从您的账户中注册的 API 密钥创建一个新的客户端来发送和接收戳记数据。然后我们发送一个请求,包含一些模拟数据([[264,172],[267,371],[242,286],[69,375],[66,221]]
),以获取与 API 密钥和戳记数据相关的戳记数据。
- 现在您应该能够在一个浏览器中打开这个 PHP 页面,它应该显示一个未格式化的 JSON 字符串,显示 'serial' 为 'DEVA'。正确格式化后,它应该看起来像这样
{
"stamp":{
"serial":"DEVA",
"customName":"DEVA"
},
"receipt":"2b6a57a3-2862-4af9-b529-bcdbe13c0453",
"created":"2020-02-05T20:10:39.8967579Z"
}
这是请求戳记信息后返回的数据。有关戳记数据请求和返回的更多信息,请访问 这里
更多信息
- 此 SDK 扩展是为了在您的服务器使用 PHP 语言作为主要代码(如 LAMP 服务器结构)时,通过 PHP 代码从我们的服务器简单检索戳记数据而制作的。
- 有关如何使用我们的产品的更多信息,请访问: https://snowshoe.readme.io/v3.0/docs