README

文档

https://www.mitryus.com.br:8191/MitryusReports/integracao.xhtml#metodoslayout

需求

• PHP >= 7.1
• Json 扩展
• Curl 扩展

使用的包

• guzzlehttp/guzzle: ^6.3
• nesbot/carbon: ^1.36
• illuminate/support: ^5.7

开始使用

• 安装
• 配置SDK
• 使用集合和方法魔术
• 获取部门
• 获取数据包
• 确认数据消费

安装

使用composer执行以下命令安装包

composer require prhost/mitryusweb-sdk

配置SDK

请看以下示例以配置主要集成密钥

use Mitryusweb\Api\Mitryusweb;

Mitryusweb::$token = 'chave de integracao';

//Opcional, setar uma outra URL que não seja a atual da documentação
Mitryusweb::$uri = 'url.ws.mitryusweb';

另一个示例

use Mitryusweb\Api\Mitryusweb;
Mitryusweb::init('chave integracao', 'url api (opcional)');

使用集合和方法魔术

集合

当期望返回多个记录的查询时，它总是会返回一个包含laravel库扩展集合的模型。集合还将其集合中的每个项目都转换为包含该记录数据的item类型的模型。

集合使用示例

$pacoteEndpoint = new \Mitryusweb\Endpoints\PacoteDados();
$pacoteDados = $pacoteEndpoint->get();

//Exemplo acessando uma coleção de dados
$departamentos = $pacoteDados->getDepartamentos();

//Por departamentos também se uma lista de dados, se torna uma model do tipo coleção.
foreach ($departamentos as $departamento) {
    $departamento->getCodDepartamento();
}

方法魔术

通过返回模型中包含的一些方法魔术，可以通过调用$pacoteDados->getDepartamentos()类型的方法来访问数据，这将仅返回该包的部门。

另一种方式是通过属性，例如，$pacoteDados->Departamentos或$pacoteDados->codigo_confirmacao。通过调用$pacoteDados->getAttributeMap()来查看属性列表。

一些使用方法魔术和集合的其他示例

获取部门

要获取部门，请使用端点Departamentos

$departamentosEndpoint = new \Mitryusweb\Endpoints\Departamentos();

//Retorna uma model de coleção baseada na instancia da biblioteca Collection do laravel
$departamentos = $departamentosEndpoint->get();

获取数据包

要获取单个数据包中的所有数据，请使用端点PacoteDados

$pacoteEndpoint = new \Mitryusweb\Endpoints\PacoteDados();

//Retorna uma model do tipo PacoteDados contendo varias coleções de cada dado.
$pacoteDados = $pacoteEndpoint->get();

//Você também pode auto confirmar a recuperação do pacote passando true no paramentro do get():
$pacoteDados = $pacoteEndpoint->get(true);

确认数据消费

要确认是否正确接收到数据，请使用以下示例中的codigo_confirmacao代码

$pacoteEndPoint = new \Mitryusweb\Endpoints\PacoteDados();

$codigo_confirmacao = 123;
$pacoteEndPoint->confimar($codigo_confirmacao);