README

需求 | 安装 | 使用 | 功能 | 建议 | 贡献 | 许可

SnelstartApiBundle

此包将 Snelstart Api 集成到 Symfony 中。Snelstart 是一款具有无缝集成任何现有 CRM 软件能力的会计云软件。

此软件包由 DSJ Productions 精心制作。

SnelstartApiBundle 遵循语义版本控制。更多关于 semver.org 的信息。

需求

• PHP 5.3 或更高版本
• Symfony 2.5 或更高版本
• Guzzle (由 composer 包含)
• Symfony 缓存组件 (由 composer 包含)

安装

要安装此包，请运行以下命令，您将通过 Packagist 获取最新版本。

composer require dsj/snelstartapi

要使用最新版（可能不稳定）的版本，请将以下内容添加到您的 composer.json 文件中（不建议，API 可能会更改）

{
    "require": {
        "dsj/snelstartapi": "dev-master"
    }
}

使用

在 AppKernel.php 中加载包

new DSJ\SnelstartApiBundle\SnelstartApiBundle()

在 parameters.yml 中进行配置

parameters:
    snelstart_application_key: the application key of your snelstart account link
    snelstart_primary_key:     the primary key of your snelstart account
    snelstart_secondary_key:   the secondary key of your snelstart account
    ...

所有这些设置都是 必需的。

在控制器中使用服务

/** @var \DSJ\SnelstartApiBundle\Manager\SnelStartManager $oSnelStartManager */
$oSnelStartManager = $this->get('dsj.snelstart');

// Do a raw GET request
$aCustomers = $oSnelStartManager->request('GET', 'relaties');

// Or call via this easy to remember syntax
$aCustomers = $oSnelStartManager->Relaties->getAll();

// Do a raw POST request
$aCustomers = $oSnelStartManager->request('POST', 'relaties', [
    'naam' => 'test',
]);

// Or call via this easy to remember syntax
$aCustomers = $oSnelStartManager->Relaties->create([
    'naam' => 'test',
]);

功能

• 由于 Swagger 文件集成，在错误的请求上显示缺少的参数
• 易于调用的端点（$oSnelStartManager->Relaties->getAll()，$oSnelStartManager->Relaties->get($id)）
• 带有失效的令牌缓存
• 在失败响应上重试请求
• 身份验证自动进行，您只需在配置中提供所需的密钥即可

注意事项

• 调用返回 null 的端点表示对象不存在或数组为空
• 您的端点将返回 stdClass 对象或 array，具体取决于您选择的端点类型。

贡献

👍 如果您想为此项目做出贡献，请阅读 CONTRIBUTING.md。

🎉 感谢参与此项目的贡献者。

许可

此包在 MIT 许可证 下发布。