leventcz/parasut-php

PHP 的 Parasut API v4 客户端

v1.1.2 2024-09-07 14:26 UTC

This package is auto-updated.

Last update: 2024-09-07 14:27:29 UTC


README

Latest Version on Packagist GitHub Tests Action Status Licence

Parasut PHP API 客户端

现代 PHP API 客户端,允许您与 Parasut API v4 交互

安装

需要 PHP 8.2+

composer require leventcz/parasut-php

使用方法

初始化客户端

$credentials = [
    'client_id' => 'YOUR_CLIENT_ID',
    'client_secret' => 'YOUR_CLIENT_SECRET',
    'company_id' => 'YOUR_COMPANY_ID',
    'username' => 'YOUR_USERNAME',
    'password' => 'YOUR_PASSWORD'
];

$client = Parasut::client($credentials);

示例

// paginate through sales invoices
$salesInvoices = $client
    ->salesInvoice()
    ->index(['page' => ['size' => 10, 'number' => 4]]);

$salesInvoices['data']; // array of sales invoices   
$salesInvoices['meta']; // pagination meta

// retrieve the specified sales invoice with its payments
$salesInvoice = $client
    ->salesInvoice()
    ->show($id, ['include' => 'payments']);

$salesInvoice['data']; // sales invoice
$salesInvoice['included']; // array of payments

方法和参数

这些方法完全遵循其相关端点命名约定,并将必需和可选参数作为参数传递。

// POST | https://api.parasut.com/v4/{company_id}/contacts/{id}/contact_debit_transactions
$client
    ->contact()
    ->contactDebitTransactions($id, $query, $body)

// PATCH | https://api.parasut.com/v4/{company_id}/employees/{id}/archive
$client
    ->employee()
    ->archive($id, $query)

API 参考

许可

Parasut PHP 是一个开源软件,根据 MIT 许可 许可。