zgldh/laravel-kefu5

Kefu5/kf5 RESTFul API for Laravel 5.1/5.2

v0.1.5 2016-08-16 06:52 UTC

Requires

• laravel/framework: ^5.1||^5.2

MIT

• zgldh

• api
• restful
• laravel
• kefu5
• kf5

README

客服5的RESTFul API。 可以和 Laravel 5 框架很好的融合。

基于官方 SDK 开发，额外提供 SSO 跳转地址生成功能！

依赖 Requirement

1. Laravel 5.1/5.2

安装 Install

1. composer require zgldh/laravel-kefu5

2. config/services.php 新增配置

       'kefu5' => [
           'domain' => // 您的云客服平台kf5二级域名地址。如 abc.kf5.com 。不要带 http://， 不要带最后的斜杠
           'token' => // 您的云客服平台的API密钥。 如 '60a0319****7fcdf63461c5ad18106'
       ],

3. Done

用法 Usage

1. 管理员查询工单列表

      use zgldh\Kefu5\Kefu5;   
   
      $client = (new Kefu5)->withAdmin($adminEmail, $adminPassword);
      $list = $client->tickets()->findAll();

2. 客服查询工单列表

      use zgldh\Kefu5\Kefu5;   
   
      $client = (new Kefu5)->withAgent($agentEmail, $agentPassword);
      $list = $client->tickets()->findAll();

3. 普通用户查询工单列表

      use zgldh\Kefu5\Kefu5;   
   
      $client = (new Kefu5)->withEndUser($userEmail);
      $list = $client->requests()->findAll();

4. 更多API用法请访问： https://github.com/waterank/KF5SDK-PHP/blob/master/index.php

5. 得到SSO重定向URL

      use zgldh\Kefu5\Kefu5;   
   
      $username = \Auth::user()->name;
      $redirectURL = (new Kefu5)->sso($username,
          [
              'name'=> '用户昵称|Email',
              'phone'=> '用户的手机',
              'photo'=> '用户的头像地址，必须以http://或https://开头',
              'rememberMe'=> true 表示保持登录的连接时间至30天,false 表示30分钟后无活动自动登录过期
          ]
      );
      
      return redirect($redirectURL);

参考资料

http://developer.kf5.com/restapi/

https://github.com/waterank/KF5SDK-PHP/blob/master/index.php

https://github.com/waterank/KF5SDK-PHP

待续