star-insure/crm-client

Star Insure CRM 客户端

1.0.0 2023-11-02 20:12 UTC

This package is auto-updated.

Last update: 2024-09-06 22:41:44 UTC


README

为 Laravel 应用程序提供的包,包括 Star Inure CRM 的包装,并提供了用于与 Star 认证应用进行认证的路由、控制器和中间件。

安装

您可以通过 composer 安装此包

composer require star-insure/crm-client

将这些值添加到您的 .env 文件中

# CRM
CRM_API_URL=http://crm.test
CRM_API_TOKEN=dev
CRM_API_GROUP_ID=2
CRM_API_VERSION=v1

发布配置

php artisan vendor:publish --tag=starinsure-crm

使用方法

API

通过实例化一个新客户端或使用 StarInsure\Api\Facades\CrmApi 门面来调用 Star CRM API。

CrmApi::get('/account-manager-brokers');

辅助函数

app 目录内创建一个 helpers.php 文件(或编辑现有的一个)

if (! function_exists('crm')) {
    /**
     * Global helper to create an instance of the StarCrm client.
     */
    function crm()
    {
        return new \StarInsure\Crm\CrmApi(
            config('crm.version'),
        );
    }
}

composer.json 中自动加载您的辅助函数文件

"autoload": {
    ...
    "files": [
        "app/helpers.php"
    ]
},

在将辅助函数文件添加到 composer.json 之后,您需要导出自加载器

composer dump-autoload

现在,您可以使用全局辅助函数,无需担心命名空间/导入。

crm()->get('/account-manager-brokers');