README

此包提供了与 Zendesk API 的集成。支持创建工单、检索和更新工单、删除工单等。

此包仅仅提供了一个 Zendesk 门面，作为对 zendesk/zendesk_api_client_php 包的包装。

注意：目前仅支持基于令牌的认证。

安装

您可以通过 Composer 使用以下命令安装此包：

composer require huddledigital/zendesk-laravel

您还必须安装服务提供者。

Laravel 5.5+ 用户：此步骤可以跳过，因为包支持自动发现。

// config/app.php
'providers' => [
    ...
    Huddle\Zendesk\Providers\ZendeskServiceProvider::class,
    ...
];

如果您想使用门面，也必须安装它。

// config/app.php
'aliases' => [
    ..
    'Zendesk' => Huddle\Zendesk\Facades\Zendesk::class,
];

配置

要发布配置文件到 app/config/zendesk-laravel.php，请运行：

php artisan vendor:publish --provider="Huddle\Zendesk\Providers\ZendeskServiceProvider"

使用 环境变量 设置您的配置，可以在您的 .env 文件或服务器控制面板上设置

• ZENDESK_SUBDOMAIN

您的 Zendesk 组织 URL 的子域名部分。

例如，http://huddledigital.zendesk.com 使用 huddledigital

• ZENDESK_USERNAME

认证账户的用户名。

• ZENDESK_TOKEN

API 访问令牌。您可以在以下位置创建一个：https://SUBDOMAIN.zendesk.com/agent/admin/api/settings

• ZENDESK_DRIVER （可选）

将其设置为 null 或 log 以防止直接从您的环境中调用 Zendesk API。

使用方法

门面

Zendesk 门面充当 Zendesk\API\Client 类实例的包装器。此类上可用的任何方法（在此处查看文档）都可通过门面使用。例如

// Get all tickets
Zendesk::tickets()->findAll();

// Create a new ticket
Zendesk::tickets()->create([
  'subject' => 'Subject',
  'comment' => [
      'body' => 'Ticket content.'
  ],
  'priority' => 'normal'
]);

// Update multiple tickets
Zendesk::ticket([123, 456])->update([
  'status' => 'urgent'
]);

// Delete a ticket
Zendesk::ticket(123)->delete();

依赖注入

如果您不想使用门面，可以跳过在 config/app.php 中添加别名，而是将 Huddle\Zendesk\Services\ZendeskService 注入到您的类中。然后，您可以使用此对象上与门面相同的所有方法。

<?php

use Huddle\Zendesk\Services\ZendeskService;

class MyClass {

    public function __construct(ZendeskService $zendesk_service) {
        $this->zendesk_service = $zendesk_service;
    }

    public function addTicket() {
        $this->zendesk_service->tickets()->create([
              'subject' => 'Subject',
              'comment' => [
                    'body' => 'Ticket content.'
              ],
              'priority' => 'normal'
        ]);
    }

}

此包受 MIT 许可 的约束。