README

用于从 openexchangerates.com 获取外汇（fx 汇率）的 PHP 客户端

安装

1. 将 qbil-software/openexchangerates 添加到 composer.json 文件中，并运行 composer update

   或者

2. 运行 composer require qbil-software/openexchangerates 安装并将此包添加到 composer.json 文件中。

3. 在您的 PHP 文件中包含 require_once 'vendor/autoload.php' 并创建 Qbil\OpenExchangeRates\Exchange 类的实例，例如 $exchange = new Qbil\OpenExchangeRates\Exchange($appId, $baseCurrency); 其中 $appId 是您的应用程序 ID，$baseCurrency 是基准货币。

(有关应用程序 ID 的更多信息，请参阅 https://docs.openexchangerates.org/docs/authentication，有关基准货币的更多信息，请参阅 https://docs.openexchangerates.org/docs/set-base-currency)。默认基准货币为 USD。如果您不想更改基准货币，请勿传递第二个参数。

1. 您现在可以使用客户端了。

方法

客户端提供了五个公开方法：`latest`、`historical`、`between`、`convert` 和 `currencies`。

除了 `currencies` 方法（它接受 不同的参数）之外，所有方法都可以接受一个关联数组作为参数，具有以下键

1. symbols 或 currencies - 仅获取指定货币的外汇汇率（以逗号分隔的格式）。
   
   例如
   $exchange->latest(['symbols' => 'USD,EUR,GBP']) 将返回 USD、EUR 和 GBP 货币的最新外汇汇率数组
2. base - 即使您在构造函数中将基准货币作为第二个参数传递，您也可以通过在参数数组中添加 base 键来覆盖它
   
   例如
   $exchange->latest(['base' => 'GBP']) 将返回以基准货币 GBP 为基准的最新外汇汇率数组

方法说明

1. latest - 此方法获取最新的外汇汇率。例如 $exchange->latest() 将返回最新的汇率数组。

2. historical - 此方法获取特定日期的外汇汇率。它有一个必需的参数键 date（yyyy-mm-dd 格式），即您想获取外汇汇率的日期。例如 $exchange->historical(['date' => '2017-10-01']) 将返回 2017-10-01 日期的汇率数组。

3. between - 此方法获取由参数键 start 和 end（均为 yyyy-mm-dd 格式）指定的特定日期之间的外汇汇率。start 和 end 分别表示开始日期和结束日期。例如 $exchange->between(['start' => '2017-10-01', 'end' => '2017-11-05']) 将返回 2017-10-01 和 2017-11-05 之间的汇率数组。

4. convert - 此方法用于使用最新的外汇汇率将任何货币价值从一种货币转换为另一种货币。它有三个必需的参数键 amount、from 和 to。`from` 和 `to` 是货币代码（3 个字母），`amount` 是您想要转换的金额。例如 $exchange->between(['amount' => '15678800', 'from' => 'USD', 'to' => 'EUR']) 将返回等价的 EUR 金额（字符串）。

5. 货币 - 此方法返回一个包含所有受支持货币的数组，其中符号用作键，货币用作值。

注意：上述一些方法仅在企业版或终极版中可用。请访问 https://openexchangerates.com 获取更多信息