oneall / php-sdk
Requires
- php: >=5.4
Requires (Dev)
- phpmd/phpmd: ~2.6
- phpunit/phpunit: @stable
This package is not auto-updated.
Last update: 2024-09-29 00:57:23 UTC
README
该SDK允许您使用PHP与OneAll API进行通信。它通过curl或socket(FSockOpen)客户端实现所有API功能。实现示例可在oneall/php-api-examples存储库中找到。
入门
先决条件
- 具有PHP >=5.4的Web服务器
- 一个免费的OneAll 账户和网站。您需要网站的子域名、公钥和私钥。
安装
composer require "oneall/php-sdk:~2.0"
测试
./vendor/bin/phpunit tests/unit --coverage-html tests/results/unit
使用我们的PHP-SDK
PHP-SDK由以下组成
- PHP客户端(curl & FSockOpen)和构建器
- API对象,用于使用我们的不同端点。
- 包含所有API对象的ApiContainer。
获取您的配置
为了使用PHP-SDK,您需要在我们的网站上找到的应用程序凭据。
$subDomain = 'your-subdomain';
$sitePublicKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
$sitePrivateKey = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
创建客户端
首先,您必须创建一个包含先前凭据的PHP客户端。您可以根据系统选择*curl或fsockopen。damie // 通过构建器创建客户端 $builder = new Oneall\Client\Builder(); $client = $builder->build('curl', $subDomain, $sitePublicKey, $sitePrivateKey);
// Or build it directly
$curlClient = new \Oneall\Client\Adapter\Curl($subDomain, $sitePublicKey, $sitePrivateKey);
使用我们的API对象
最后,实例化您需要的ApiObject(更多详细信息,请参阅api文档)。每个ApiObject都需要客户端才能与服务交互(并自动登录)。
$connectionApi = new \Oneall\Api\Apis\Connection($client);
$connections = $api->getConnectionApi()->getAll();
您可以使用ApiContainer来简化它们的实例化。
$api = new \Oneall\OneallApi($client);
$connections = $api->getConnectionApi()->getAll();
例如,如果您想在Twitter上发布消息。
$api = new \Oneall\OneallApi($client);
$twitter_api = $api->getProviderApi()->getProviderApi('twitter');
$twitter_api->publish($identity_token, $message);
文档
更多关于我们的文档信息。
以下是关于在已经拥有用户账户的网站上实现我们的社交登录、社交链接和单点登录服务的逐步文档。
许可证
GNU通用公共许可证,可在https://gnu.ac.cn/licenses/old-licenses/gpl-2.0.html找到