xero / xero-php-sample-app
1.0.1
2019-01-16 20:06 UTC
Requires
- php: >=5.5.0
- calcinai/xero-php: ^1.8
- league/plates: ^3.3
- league/route: ^3.0
- zendframework/zend-diactoros: ^1.7
This package is auto-updated.
Last update: 2019-12-16 19:59:09 UTC
README
OAuth1.0a 弃用
- 2019 年 12 月初 - 不再创建新的 OAuth 1.0a 应用。
- 2019 年 12 月中旬 - OAuth 2.0 迁移端点对合作伙伴应用可用。
- 2020 年 12 月 - OAuth 1.0a 不再支持现有集成。
这是一个 xero-php SDK 的示例应用。目前,此应用专注于演示所有会计 API 端点和相关操作的功能。
您将能够连接到 Xero 组织并执行真实 API 调用。每个 API 调用所使用的代码将显示出来,以及 Xero API 返回的结果。
Xero 应用
此示例应用使用 Xero 公共 应用。
访问 http://app.xero.com 并使用您的 Xero 用户账户登录以创建 Xero 公共应用。您将设置回调 URL 并获取您的消费者密钥和密钥。
设置应用
请确保您已安装 Composer,然后使用以下命令创建此项目
composer create-project xero/xero-php-sample-app
这将下载此项目及其所有依赖项到名为 xero-php-sample-app
的文件夹中
配置
在 config/xero.example.php
中有一个示例配置文件,其中包含所有必需的参数。将该文件复制到 config/xero.php
并插入您的消费者密钥和密钥。
return [ 'oauth' => [ //This is just for demo purposes, it should be set from a more reliable source for production use 'callback' => "http://$_SERVER[HTTP_HOST]/application/callback", 'consumer_key' => 'YOUR_CONSUMER_KEY', 'consumer_secret' => 'YOUR_CONSUMER_SECRET', 'signature_location' => \XeroPHP\Remote\OAuth\Client::SIGN_LOCATION_QUERY, ], 'curl' => [ CURLOPT_USERAGENT => 'XeroPHP Sample App', CURLOPT_CAINFO => APP_ROOT . '/certs/ca-bundle.crt', ], ];
运行
运行此项目(配置最少)的最佳方式是使用 PHP 的开发网络服务器。切换到 webroot 并在您选择的端口上启动它
cd xero-php-sample-app/public
php -S localhost:8999
现在,您应该能够导航到 http://localhost:8999 并使用应用程序。
xero-php SDK 中不支持哪些功能?
我们找不到使用 xero-php SDK 演示以下操作的方法。
报告
- 十NinetyNine
- 逾期应付款
- 逾期应收款
- 银行对账单 - 缺少必需的银行账户 ID
- 银行摘要
- 执行摘要
- 试算表
税率
- 允许您删除 Xero 组织的税率
以下操作都受支持,但此应用程序中尚未实现示例
联系人组
- 允许您从联系人组中删除联系人
- 允许您从联系人组中删除所有联系人
货币
- 将货币添加到您的组织
发票
- 检索销售发票的在线发票 URL
发票提醒
- PR 已提交以添加对 SDK 的支持
跟踪类别
- 添加新选项
- 重命名选项
- 更新选项
- 删除选项
致谢
许可证
本软件根据 MIT 许可证 发布。
Copyright (c) 2018 Xero Limited
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.