herojhc/xxh-sdk

xinxihua.com sdk.

title: 信息化平台SDK使用说明 tags: 信息化、SDK, _(*1)

grammar_mindmap: true

环境

laravel 5.5 或 5.6 以及他们需要的环境, _(*2)

安装

``` r composer require herojhc/xxh-sdk, <sub>(*3)</sub>

# 配置

## 发布配置

``` php-cli
php artisan vendor:publish --provider="XinXiHua\SDK\XXHServiceProvider" --tag="xxh-sdk-config"

运行迁移

``` php-cli php artisan vendor:publish --provider="XinXiHua\SDK\XXHServiceProvider" --tag="xxh-sdk-migrations", <sub>(*4)</sub>

php artisan migrate, <sub>(*5)</sub>

## 修改User模型主键

``` php
protected $primaryKey = 'user_id';

参数说明

配置环境变量, <sub>(*6)</sub>

``` makefile, <sub>(*7)</sub>

-----------

AppId，具体见应用详情

REST_CLIENT_ID=cd188ae7d6344beb8ccc660643bf886f, <sub>(*8)</sub>

AppSecret，具体见应用详情

REST_CLIENT_SECRET=138fa802f76c4f0ba472cfe9d9ebf852, <sub>(*9)</sub>

Api 地址

REST_CLIENT_API_URL=https://api.xinxihua.com, <sub>(*10)</sub>

具体API的HOST，不同的API分支对应不同的HOST，具体见信息化平台API总览

REST_CLIENT_API_HOST=api.v2.services.xinxihua.com, <sub>(*11)</sub>

-------------

应用的ID（信息化平台），具体见应用详情

AUTH_AGENT_ID=10000, <sub>(*12)</sub>

前台回调地址

AUTH_CALLBACK_HOME_URL=http://crm.xinxihua.com/callback, <sub>(*13)</sub>

登录后前台跳转页面

AUTH_REDIRECT_HOME_URL=http://crm.xinxihua.com/home, <sub>(*14)</sub>

后台回调地址

AUTH_CALLBACK_ADMIN_URL=http://crm.xinxihua.com/admin/callback, <sub>(*15)</sub>

登录后后台跳转地址

AUTH_REDIRECT_ADMIN_URL=http://crm.xinxihua.com/admin, <sub>(*16)</sub>

信息化平台地址

AUTH_PALTFORM_URL=https://oa.xinxihua.com, <sub>(*17)</sub>

信息化平台授权登陆地址

AUTH_GATEWAY_URL=https://oa.xinxihua.com/sso-login, <sub>(*18)</sub>

应用通讯的TOKEN

AUTH_TOKEN=1QchOH0JQ6PGTCcFSapG, <sub>(*19)</sub>

应用通讯的加密字符串

AUTH_ENCODING_KEY=ZOFV3OSokCBmaC34zP3FM41B88dccl7AC65RuaoyuaB, <sub>(*20)</sub>

# 使用

## 路由配置
* 在web路由中配置 

``` php
XXH::routes();

说明：XXH::routes() 包含以下路由，如果要控制权限，可以通过中间件方式, <sub>(*21)</sub>

``` php Route::get('login', '\XinXiHua\SDK\Http\Controllers\LoginController@login')->name('login'); Route::post('logout', '\XinXiHua\SDK\Http\Controllers\LoginController@logout')->name('logout'); Route::get('callback', '\XinXiHua\SDK\Http\Controllers\LoginController@callback')->name('callback'); Route::get('admin/login', '\XinXiHua\SDK\Http\Controllers\Admin\LoginController@login')->name('admin.login'); Route::post('admin/logout', '\XinXiHua\SDK\Http\Controllers\Admin\LoginController@logout')->name('admin.logout'); Route::get('admin/callback', '\XinXiHua\SDK\Http\Controllers\Admin\LoginController@callback')->name('admin.callback'); Route::any('serve', '\XinXiHua\SDK\Http\Controllers\ServeController@serve')->name('serve');, <sub>(*22)</sub>

* 将 serve 添加到 VerifyCsrfToken 中间件中

``` php
<?php

namespace App\Http\Middleware;

use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;

class VerifyCsrfToken extends Middleware
{
    /**
     * The URIs that should be excluded from CSRF verification.
     *
     * @var array
     */
    protected $except = [
        //
        'serve'
    ];
}

用法

``` php, <sub>(*23)</sub>

<?php /** * Created by PhpStorm. * User: JHC * Date: 2018-07-24 * Time: 11:51 */, <sub>(*24)</sub>

namespace XinXiHua\SDK\Services;, <sub>(*25)</sub>

use Illuminate\Support\Facades\Log; use XinXiHua\SDK\Exceptions\ApiException;, <sub>(*26)</sub>

class ContactService extends BaseService {, <sub>(*27)</sub>

public function all()
{
    $response = $this->client->get('/contacts');

    Log::info($response->getResponse());
    if ($response->isResponseSuccess()) {
        return $response->getResponseData()['data'];
    }
    throw new ApiException($response->getResponseData()['message']);

}

}, <sub>(*28)</sub>

```, <sub>(*29)</sub>