README

Laravel Zendesk

本包提供了一个优雅的官方 Zendesk API PHP 库包装器。它支持创建工单、检索和更新工单、删除工单等。

安装

使用 Composer 安装此包

composer require homedesignshops/laravel-zendesk

Laravel 5.5+ 用户：以下省略服务提供者安装，因为该包已配置为 包发现。

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

配置

将配置文件发布到 app/config/zendesk.php 运行

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

使用 .env 文件中的 环境变量 设置您的配置

ZENDESK_SUBDOMAIN

您 Zendesk 组织的子域名部分。

例如：如果您的组织域名为 https://homedesignshops.zendesk.com，则使用 homedesignshops 作为子域名

ZENDESK_USERNAME
您在 Zendesk 组织中的认证账户的用户名。

ZENDESK_TOKEN
API 访问令牌。这可以是一个 basic 令牌或您的 oauth 令牌。您可以在 https://{SUBDOMAIN}.zendesk.com/agent/admin/api/settings 处管理您的令牌。

使用方法

辅助工具

Zendesk 辅助工具充当 Zendesk\API\Client 类实例的包装器。您可以在 zendesk/zendesk_api_client_php 存储库中找到此类上所有可用的方法。所有方法都可通过辅助工具访问。

示例

<?php
// Get all tickets
zendesk()->tickets()->findAll();

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

// Update ticket status to urgent
zendesk()->tickets(123)->update([
  'status' => 'urgent'
]);

// Delete a ticket
zendesk()->tickets(123)->delete();

依赖注入

<?php

use HomeDesignShops\Zendesk\ZendeskClient;

class TicketsClass {

    protected $zendeskClient;

    public function __construct(ZendeskClient $zendeskClient) {
        $this->zendeskClient = $zendeskClient;
    }

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

}

此包受 MIT 许可证 保护。