README

非官方的www.tiny.com.br API 集成 SDK

安装

可以使用依赖管理器 composer 安装此库。要安装库及其所有依赖项，请执行以下命令：

composer require softr/tinyerp-php-sdk:1.0

为了使用 WebService，需要使用一个 REST 客户端，它将负责与 WebService 的通信。默认情况下，库包含了用于使用 Buzz、Guzzle 和 GuzzleHttp 包的“适配器”。安装以下包中的一个：

composer require kriswallsmith/buzz
composer require guzzle/guzzle
composer require guzzlehttp/guzzle

或者将以下包之一添加到您的 composer.json 文件中：

{
    "require": {
        "kriswallsmith/buzz": "dev-master",
        "guzzle/guzzle": "^3.9@dev",
        "guzzlehttp/guzzle": "^6.1"
    }
}

适配器

您可以使用以下 适配器 在您的应用程序中使用：BuzzAdapter、GuzzleAdapter 和 GuzzleHttpAdapter；

示例

<?php

require 'vendor/autoload.php';

use Softr\TinyERP\Adapter\BuzzAdapter;
use Softr\TinyERP\Adapter\GuzzleAdapter;
use Softr\TinyERP\Adapter\GuzzleHttpAdapter;
use Softr\TinyERP\TinyERP;

// Instancie o adapter usando o token de acesso
$adapter = new BuzzAdapter('seu_token_de_acesso');
ou
$adapter = new GuzzleAdapter('seu_token_de_acesso');
ou
$adapter = new GuzzleHttpAdapter('seu_token_de_acesso');

// Instancie o cliente TinyERP usando a instância do adapter previamente criada.
$asaas = new TinyERP($adapter);

端点

如果您想以测试模式使用 API，只需在实例化客户端时指定 环境 即可。

// Obs.: Caso não seja informado o segundo parâmetro a API entra em modo de produção
$asaas = new TinyERP($adapter, 'producao|homologacao');

客户端

// Retorna a listagem de clientes
$clientes = $asaas->customer()->getAll(array $filtros);

// Retorna os dados do cliente de acordo com o Id
$cobranca = $asaas->customer()->getById(123);

// Retorna os dados do cliente de acordo com o Email
$clientes = $asaas->customer()->getByEmail('email@mail.com');

// Insere um novo cliente
$cobranca = $asaas->customer()->create(array $dadosCliente);

// Atualiza os dados do cliente
$cobranca = $asaas->customer()->update(123, array $dadosCliente);

// Deleta uma cliente
$asaas->customer()->delete(123);

收费

// Retorna a listagem de cobranças
$cobrancas = $asaas->payment()->getAll(array $filtros);

// Retorna os dados da cobrança de acordo com o Id
$cobranca = $asaas->payment()->getById(123);

// Retorna a listagem de cobranças de acordo com o Id do Cliente
$cobrancas = $asaas->payment()->getByCustomer($customer_id);

// Retorna a listagem de cobranças de acordo com o Id da Assinaturas
$cobrancas = $asaas->payment()->getBySubscription($subscription_id);

// Insere uma nova cobrança
$cobranca = $asaas->payment()->create(array $dadosCobranca);

// Atualiza os dados da cobrança
$cobranca = $asaas->payment()->update(123, array $dadosCobranca);

// Deleta uma cobrança
$asaas->payment()->delete(123);

订阅

// Retorna a listagem de assinaturas
$assinaturas = $asaas->subscription()->getAll(array $filtros);

// Retorna os dados da assinatura de acordo com o Id
$assinatura = $asaas->subscription()->getById(123);

// Retorna a listagem de assinaturas de acordo com o Id do Cliente
$assinaturas = $asaas->subscription()->getByCustomer($customer_id);

// Insere uma nova assinatura
$assinatura = $asaas->subscription()->create(array $dadosAssinatura);

// Atualiza os dados da assinatura
$assinatura = $asaas->subscription()->update(123, array $dadosAssinatura);

// Deleta uma assinatura
$asaas->subscription()->delete(123);

通知

// Retorna a listagem de notificações
$notificacoes = $asaas->notification()->getAll(array $filtros);

// Retorna os dados da notificação de acordo com o Id
$notificacao = $asaas->notification()->getById(123);

// Retorna a listagem de notificações de acordo com o Id do Cliente
$notificacoes = $asaas->notification()->getByCustomer($customer_id);

// Insere uma nova notificação
$notificacao = $asaas->notification()->create(array $dadosNotificacao);

// Atualiza os dados da notificação
$notificacao = $asaas->notification()->update(123, array $dadosNotificacao);

// Deleta uma notificação
$asaas->notification()->delete(123);

城市

// Retorna a listagem de cidades
$cidades = $asaas->city()->getAll(array $filtros);

// Retorna os dados da cidade de acordo com o Id
$action123 = $asaas->city()->getById(123);

官方文档

注意：这是一个非官方 API。它是基于以下链接提供的文档制作的：此链接。

致谢

• Agência Softr Ltda - www.softr.com.br
• 此库是基于以下链接提供的 DigitalOcean API 制作的：此链接

支持

要报告新的错误，请请在 github 上创建一个新的 Issue

许可

基于 MIT 许可证分发。复制、粘贴、修改、改进和分享，无需担忧 ;)