README

| | | | | |

Brex SDK for PHP

这是一个 SDK，允许 PHP 应用程序快速使用 Brex REST API 来完成 API 提供的所有常见银行任务。通过 代码生成，我们目前支持完整的 API 覆盖。

当然，您需要成为 Brex 客户才能从该库中获得任何使用价值。

注意：这是一个金融软件。Brex API 的性质意味着大多数使用都会涉及处理高度敏感的金融数据或货币转账。您完全负责确保实施适当的保护措施来保护您的财产（金钱和信息）。请遵守 LICENSE（及其 免责声明），并彻底理解 SECURITY（以及此实现的限制）。

入门

要求

• Brex 账户
• PHP 8.1
• Composer
• 实现 PSR7 的库

安装

使用 Composer 安装 nxsys/library.client-brex。

composer require nxsys/library.client-brex

此库允许您保留在应用程序中可能已经使用的 http 客户端库。它通过 服务发现 来实现。如果您没有使用 PSR-7 兼容的 HTTP 客户端，则需要 安装一个。

我们已经测试了它与 Symfony 的 HTTP 客户端。请安装下面的包。

composer require symfony/http-client

如果这很令人困惑，请阅读 https://docs.php-http.org/en/latest/httplug/users.html，并且不要犹豫 与我们聊天！

使用/示例

<?php
#if using composer use the autoloader
require 'vendor\autoload.php';

use NxSys\Library\Clients\Brex as BrexSdk;

$oSDK=new BrexSdk\SDKHost;

//Let's get company details to start
$oTeamClient=$oSDK->setAuthKey('BREX TOKEN') #consider using a token vault
	->setupTeamClient();

/** @var BrexSdk\API\Team\Client */
$oTeamClient;

//... OR
//if you will be doing work across the API, use the follow convenience method
$oTeamClient=$oSDK->setupAllClients()->getTeamClient();
//etc...

/** @var BrexSdk\API\Team\Model\CompanyResponse */
$aCompanyDetails=$oTeamClient->getCompany();

$sCompanyName=$aCompanyDetails->getLegalName();
// ACME Corp, Inc.

文档

• 用户手册
• 类参考
• Brex API 参考

反馈

以下沟通渠道是开放的

• 聊天： https://onx.zulipchat.com
• 问题： https://github.com/NxSys/library.clients-brex/issues
• 论坛： https://github.com/NxSys/library.clients-brex/discussions

• 源代码： https://github.com/NxSys/library.clients-brex

如果您有任何反馈，请通过onx@nxs.systems与我们联系

贡献

首先，感谢您抽出时间进行贡献！贡献使得开源社区成为一个如此出色的学习、启发和创造的地方。您所做的任何贡献都将惠及所有人，并且我们非常感激。

请阅读我们的贡献指南，感谢您的参与！

请遵守本项目行为准则。

使用情况

本项目被以下项目使用

• Brex CLI客户端（作为参考实现）

安全性

此库试图遵循良好的安全实践，但不能保证100%的安全。此库提供“现状”且不附带任何保证。使用风险自负。

有关更多信息和安全问题的报告，请参阅我们的安全文档。

许可（MIT）

版权（c）2023 Nexus Systems，Inc。未经明确授权的权利均予保留。

特此授予任何获得此软件及其相关文档副本（以下简称“软件”）的人免费使用权，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许将软件提供给他人以供其使用，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的副本或主要部分中。

软件按“现状”提供，不提供任何明示或暗示的保证，包括但不限于适销性、特定用途的适用性和非侵权性保证。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任负责，无论该责任是基于合同、侵权或其他法律依据，以及软件或其使用或其它方式产生的。

有关更多信息及第三方通知，请参阅LICENSE。

作者

• Open Nexus Group onx@nxs.systems

致谢

• Brex
• Jane
• 如何编写好的README
• Write the Docs: 文档指南