flipoll / php-sdk
PHP fliPoll SDK
Requires
- php: ^5.4|^7.0
This package is not auto-updated.
Last update: 2024-09-29 03:10:11 UTC
README
此仓库包含PHP代码,允许轻松将fliPoll集成到服务器端应用程序中。
资源
- REST API概述 - REST API的目的和基本功能
- API入门指南 - 如何开始使用REST API
- REST API参考 - 所有REST API资源列表
- PHP SDK概述 - PHP SDK的设计和基础
- PHP SDK入门指南 - 如何开始使用PHP SDK
- PHP SDK参考 - 主要PHP SDK类列表
- API SDK - 所有可用的REST API SDK
入门
-
在fliPoll上注册 - 在您可以使用SDK之前,您需要一个fliPoll帐户以及应用凭据。要创建帐户,请访问fliPoll并点击屏幕右上角的注册按钮。
-
创建fliPoll应用 - 一旦您有了fliPoll帐户,请登录并导航到您的应用仪表板以创建应用,然后保存其
应用ID
和应用密钥
以供以后使用。 -
最低要求 - PHP SDK需要包括PHP >= 5.4和编译了cURL >= 7.20.0的系统。
-
安装SDK - PHP SDK可以通过Composer安装,或者从GitHub下载SDK压缩文件并将其直接包含在内。
-
通过Composer安装
-
通过命令行安装Composer。
$ curl -sS https://getcomposer.org/installer | php
-
通过命令行运行Composer命令以安装SDK的最新稳定版本。
$ php composer.phar require flipoll/php-sdk
-
在将使用SDK的PHP文件(s)顶部要求Composer的自动加载器。
require 'vender/autoload.php';
-
-
通过Zip安装
-
从GitHub下载zip文件。
-
将src目录复制到将使用SDK的代码库中。
-
在将使用SDK的PHP文件(s)顶部要求fliPoll自动加载器。
require '/path/to/fliPoll/autoload.php';
-
-
-
使用SDK - 要了解如何使用PHP SDK,请参阅PHP SDK入门指南,该指南是有关SDK设计和如何将其合并到应用程序中的最佳信息资源。有关SDK中包含的主要类的详细信息,请参阅PHP SDK参考。
示例
初始化
以下代码使用最低必需选项初始化PHP SDK。
require 'vender/autoload.php'; $fliPoll = \fliPoll\fliPoll([ 'app_id' => '{app-id}', 'app_secret' => '{app-secret}' ]);
应用访问令牌检索
以下代码初始化PHP SDK然后从fliPoll服务器检索应用访问令牌。
require 'vender/autoload.php'; $fliPoll = \fliPoll\fliPoll([ 'app_id' => '{app-id}', 'app_secret' => '{app-secret}' ]); try { // Get an OAuth 2.0 client $oauth2Client = $fliPoll->getOAuth2Client(); // Retrieve an app access token from the fliPoll servers $accessToken = $oauth2Client->getAppAccessToken(); // Set an access token with the base class dynamically $fliPoll->setAccessToken($accessToken); } catch (\fliPoll\Exceptions\fliPollSdkException $e) { exit('SDK error occurred: ' . $e->getMessage()); } catch (\fliPoll\Exceptions\fliPollAuthenticationException $e) { exit('Authentication error occurred: ' . $e->getMessage()); } catch (\Exception $e) { exit('Error occurred: ' . $e->getMessage()); }
API请求
以下代码使用现有访问令牌初始化PHP SDK然后执行API请求并输出结果。
require 'vender/autoload.php'; $fliPoll = \fliPoll\fliPoll([ 'app_id' => '{app-id}', 'app_secret' => '{app-secret}', 'access_token' => '{access-token}' // Set an access token at initialization ]); try { // Execute an API request and retrieve the response $response = $fliPoll->api('/461'); // Output the results of the API request var_dump($response->getResults()); } catch (\fliPoll\Exceptions\fliPollSdkException $e) { exit('SDK error occurred: ' . $e->getMessage()); } catch (\fliPoll\Exceptions\fliPollApiException $e) { exit('API error occurred: ' . $e->getMessage()); } catch (\Exception $e) { exit('Error occurred: ' . $e->getMessage()); }
贡献
我们是社区协作的大支持者,因此我们鼓励我们的用户提交潜在错误以及建议的功能和改进。
为了帮助我们更好地处理问题请求,请首先搜索现有的问题列表,以验证您的问题是否已经被报告。此外,建议提供遇到问题时使用的PHP版本、操作系统名称和版本以及SDK版本。
许可证
有关更多信息,请参阅许可证文件。