agrodata/ptax

用于使用巴西银行ptax服务的包

2.0.0 2024-04-03 19:07 UTC

This package is auto-updated.

Last update: 2024-09-03 19:56:50 UTC


README

logo

&nbsp;<img src="https://img.shields.io/packagist/v/agrodata/ptax.svg" />
 <img src="https://img.shields.io/packagist/dt/agrodata/ptax.svg" />

PTAX服务

负责管理系统使用的PTAX值的包。

想了解更多,请访问微服务的文档

这是负责项目与我们的PTAX服务之间通信的接口。

安装

Laravel / Lumen

使用以下命令通过composer安装包

composer require agrodata/ptax

*仅适用于"Lumen框架"

bootstrap/app.php文件中注册provider文件,在文件末尾添加以下行。

$app->register(\Agrodata\PtaxServiceProvider::class);

配置

要配置库,请使用以下命令,该命令将注册provider并在项目内部创建配置文件(可选)。配置文件仅包含微服务PTAX API的URL(AGRODATA_PTAX_URL

php artisan agrodata-ptax:install
<?php # config/agrodata-ptax.php

return [
    'url' => env('AGRODATA_PTAX_URL', 'https://ptax.agrodata.agr.br')
];

使用

配置完成后,可以在项目的任何地方实例化\Agrodata\Ptax\PtaxService::class,从而可以调用ptax微服务的方法;

ptax(string $date, [bool $strict = false]): string

接受格式为"Y-m-d"的日期和一个可选参数strict,如果为true,则严格获取指定日期的日期,如果为false,则获取d-1的日期。

将返回包含示例的数组...

{
    "date": "2023-07-24", //data
    "buy": "4.7451", //valor de compra
    "sell": "4.7457", //valor de venda
    "average": "4.7454" //média entre a compra e venda
};
<?php

use Agrodata\Ptax\PtaxService;

$ptaxValues = (new PtaxService)->ptax('2023-07-25');

ptax完整使用流程