nikitin/yclients-laravel-sdk

v0.3.3 2019-03-27 11:25 UTC

README

Latest Stable Version Latest Unstable Version Total Downloads License

Laravel YClients SDK

Install

$ composer require e-nikitin/yclients-laravel-sdk

Publish config file

$ php artisan vendor:publish --tag=yclients-laravel-sdk

Laravel 5.5+

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php

...
 nikitin\YClientsSDK\YClientsSDKServiceProvider::class
...

Set configs\yclients-laravel-sdk

'accounts' => [
     'default' => [
     // Login and password are required to receive USER TOKEN. 
     // If you have them you do not have to fill in these fields
     'login' => '',
     'password' => '',
      // Used in all requests and is mandatory
     'bearer_token' => '',
     'user_token' => ''
   ],
]

Obtain TOKENS

Bearer token can be recived from yclients support.

To obtain user token set login, password and bearer token in configs and run

    use nikitin\YClientsSDK\Facades\YClientsSDK;
    ...
    YClientsSDK::authorization()->get() // return USER TOKEN

Supported API methods

  • Authorization
  • Clients
  • Companies
  • Goods
  • Records
  • Salons
  • Services
  • ServiceCategory
  • Staff
  • Visits
    • VisitDetails

Examples

Clients

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$clients = YClientsSDK::clients()->setCompany($companyId)->get();

Companies

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$companies = YClientsSDK::companies()->setSalonId($salonId)->get();

Goods

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$goods = YClientsSDK::goods()->setCompany($companyId)->get();

Records

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$records = YClientsSDK::records()->setCompany($companyId)->setChangedAfter(Carbon::today())->get();

Groups

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$salons = YClientsSDK::groups()->get();

ServiceCategory

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$serviceCategory = YClientsSDK::serviceCategory()->setCompany($companyId)->get();

Staff

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$staff = YClientsSDK::staff()->setCompany($companyId)->get();

Visits

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$visits = YClientsSDK::visits()->setVisitId($visitId)->get();

VisitDetails

use nikitin\YClientsSDK\Facades\YClientsSDK;
...
$visitDetails = YClientsSDK::visitDetails()->setVisitId($visitId)->setSalonId($salonId)->setRecordId($recordId)->get();

License

The MIT License (MIT). Please see License File for more information.