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许可证。