README

这是一个用于与 Scoro Rest API 交互的非官方库。

安装

使用 composer 安装。

composer require coderjerk/scoro-php

示例

实例化类

use Coderjerk\ScoroPhp\ScoroPhp;

//add your company account id and api key, which you've stored safely in your env, for example.
$scoro = new ScoroPhp(
    $_ENV['SCORO_COMPANY_ACCOUNT_ID'],
    $_ENV['SCORO_API_KEY'],
);

该库提供了一种流畅的接口，允许您通过方法链构建查询

$contacts = $scoro->module('contacts')->action('list')->call();

foreach ($contacts->data as $contact) {
   echo "<li>{$contact->name}</li>";
}

向您的查询添加过滤器

$scoro->module('contacts')
    ->action('list')
    ->filter(['contact_type' => 'company'])
    ->call();

// you can dig in deep by nesting arrays depending on your data/module:

$filters = [
    'contact_type' => 'company',
    'means_of_contact' => [
        'website' => 'www.exampleclienta.co.uk'
    ]
];

$scoro->module('contacts')
    ->action('list')
    ->filter($filters)->call();

使用 id() 方法定位单个实体

$scoro->module('contacts')
    ->action('view')
    ->id(36)
    ->call();

使用 paginate() 方法设置页面和每页值

$scoro->module('contacts')
    ->action('list')
    ->paginate(10, 2)
    ->call();

方法参考

所有方法都是可选的，除了必须始终指定的模块。实际上，在绝大多数情况下这也适用于动作。请求结束后使用 call()。

参考

显然，您需要 Scoro 账户才能使用该 API。阅读他们的 API 参考，了解限制、速率限制以及可用端点的详细信息。

Scoro API 参考

coderjerk / scoro-php

维护者

详细信息

README

安装

示例

方法参考

参考