smartapps / php-api
一个连接到S.M.A.R.T平台的库,可以将网页与智能数据集成
Requires
- php: >=5.3.0
This package is not auto-updated.
Last update: 2024-09-24 03:02:59 UTC
README
这个库可以帮助开发者创建与S.M.A.R.T平台(www.smartapps.com.br)集成的网页
要求
- Composer
- cUrl Library
- PHP >= 5.3
源代码
您可以在 src 文件夹中找到库的源代码。
使用composer安装示例
####1. 第一步,安装composer :) 要安装它,您需要运行 composer install 或 php compose.phar install。
####2. 安装库 您需要使用 Composer 安装此库。因此,在您的 composer.json 中添加包名 smartapps/php-api 在 dev-master 版本。如果想要使用CLI进行操作,请运行命令: composer require "smartapps/php-api:dev-master"。
####3. 运行示例 :D 在主文件夹中,您可以在浏览器中打开文件或在CLI中运行示例: php examples/basic_data.php
示例
基本数据(basic_data.php)
此示例展示了如何从应用程序获取数据
执行方法(exec_method.php)
此示例展示了如何在应用程序上执行一个方法
简单POST(exec_method_post_simple.php)
此示例展示了如何发送一个简单的数据块。
大量数据POST(exec_method_post_massive.php)
此示例展示了如何将数据数组发送到应用程序上的任何方法。
查看表单
此示例展示了您如何查看应用程序上的可用表单。
查看模式
此示例展示了您如何查看应用程序的数据模式。
注意:如果您喜欢这些示例并且想要更多,请随时帮助我们。让我们一起用网络改变世界。
库方法
以下您可以查看此库中可用的方法。
connect($app, $api_user=false, $api_key=false)
您需要使用此方法来连接到S.M.A.R.T
######参数 $app : 您想要连接的应用程序。 $api_user : API用户:P,您可以在您环境的“API工具”选项中的“已注册密钥”中找到它。 $api_key : API密钥:P,您可以在您环境的“API工具”中找到它。
connectionClose()
您需要使用此方法来从S.M.A.R.T断开连接
method($conn, $schema, $method, $args=false, $return="json", $app=false)
您可以使用此方法直接使用方法作为引用来执行GET请求。
######参数 $conn : 连接对象引用,在connect方法的返回值中找到。 $schema : 数据模式 $method : 方法名称 $args : 方法需要的参数数组 $return : 请求返回的类型 $app : 在执行此方法时订阅的应用程序。
methodPost($conn, $schema, $method, $postVars, $args=false, $return="json", $app=false)
您可以使用此方法直接使用方法作为引用来执行POST请求。
######参数 $conn : 连接对象引用,在connect方法的返回值中找到。 $schema : 数据模式 $method : 方法名称 $args : 方法需要的参数数组 $return : 请求返回的类型 $app : 连接后订阅应用程序的一种方式。
getSchemas($conn)
您可以使用此方法查看应用程序上可用的哪些模式。
######参数 $conn : 连接对象引用,在connect方法的返回值中找到。
getForms($conn, $schema)
您可以使用此方法查看表单。
######参数 $conn : 连接对象引用,在connect方法的返回值中找到。 $schema : 数据模式。
getData($conn, $schema, $form)
您可以使用此方法来获取数据。
######参数 $conn : 连接对象引用,在 connect 方法返回时找到。$schema : 数据模式。$form : 表单名称。
getFile($conn, $file, $mime, $date)
您可以使用此方法来获取文件路径。
######参数 $conn : 连接对象引用,在 connect 方法返回时找到。$file : 文件名。$mime : 文件 MIME 类型。$date : 文件注册日期。
sendExec($conn, $app, $schema, $form, $postVars, $return="json")
您可以使用此方法向表单发送数据。
######参数 $conn : 连接对象引用,在 connect 方法返回时找到。$app : 应用程序。$schema : 数据模式。$form : 表单名称。$postVars : 发送数据的数组数据。$return : 请求返回值。
sendTo($conn, $schema, $form, $postVars=false, $app=false)
您可以使用此方法直接向表单发送数据。
######参数 $conn : 连接对象引用,在 connect 方法返回时找到。$app : 应用程序。$schema : 数据模式。$form : 表单名称。$postVars : 发送数据的数组数据。$app : 连接后订阅应用程序的方式。
如果您想了解更多关于 S.M.A.R.T 平台 API 工具的详细信息,请参阅 Smartapps 网站上的 API 文档(www.smartapps.com.br)。
@作者 José Wilker jose.wilker@smartapps.com.br