Skip to content

Latest commit

 

History

History
699 lines (488 loc) · 17.4 KB

README.md

File metadata and controls

699 lines (488 loc) · 17.4 KB
Raw

Описание

PHP класс для работы с API DeliveryAuto

Latest Stable Version Total Downloads License

Документация

API по работе интернет магазинов с Delivery v3.2 (Оформление)

Требование

  • PHP 5.6 или выше
  • Composer

Composer

composer require jackmartin/deliveryauto dev-master

Библиотеки

  1. Guzzle

Методы API

  1. Подключение класса
  2. Получить список областей
  3. Получить список городов
  4. Получение списка представительств
  5. Получение подробной информации о представительстве
  6. Поиск представительств
  7. Получение списка представительств по ID города
  8. Поиск квитанции
  9. Расчет времени доставки
  10. Показать список доп. услуг
  11. Показать список тарифов
  12. Показать список схем доставок
  13. Расчет стоимости перевозки
  14. Показать новости компании
  15. Показать темы сообщений
  16. Отправление сообщения
  17. Отправление оценки отделения
  18. Отправление оценки компании
  19. Авторизация
  20. Выйти с профиля
  21. Получить информацию о пользователе
  22. Получить квитанцию пользователя
  23. Получить список платежных карт клиента
  24. Получить список расчетных счетов клиента
  25. Получить список категорий отправляемого груза
  26. Получить доступную валюту на отделении
  27. Получить список плательщиков
  28. Получить список адресов клиента
  29. Получить список возможных адресов клиента
  30. Получить список типов оплаты клиента
  31. Получить список складов / почтоматов по ID города
  32. Получить полную информацию по квитанции

Примеры

Подключение класса

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

//$devAuto = new Auto();
//$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET', 'ua', 1); 
//$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET', 'ru', 2);
//Auto(Ваш ключ API, Язык информации, Код страны(1 - Украина, 2 - Россия))

regionList()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->regionList());

cityList($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->cityList(array(
    'fl_all'   => 0,
    'regionId' => 3898,
)));
//print_r($devAuto->cityList());

warehousesList($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->warehousesList(array(
    'includeRegionalCenters' => false,
    'CityId'                 => null,
    'RegionId'               => 3898,
)));

getWarehouse($id)

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->getWarehouse('2711ddd1-da49-e211-9515-00155d012d0d'));

findWarehouse($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->findWarehouse(array(

    'Longitude'              => '49.2386',
    'Latitude'               => '10.5194',
    'count'                  => 10,
    'includeRegionalCenters' => false,
    'CityId'                 => null,
)));

getWarehouseCity($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->getWarehouseCity(array(

    'CityId'         => '75491888-1429-e311-8b0d-00155d037960',
    'onlyWarehouses' => false,

)));

timeDelivery($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->timeDelivery(array(

    'areasSendId'   => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'areasResiveId' => 'b3db16a5-832a-e311-8b0d-00155d037960',
    'dateSend'      => '11.10.2017',
    'currency'      => 'ua',

)));
<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->timeDelivery(array(

    'areasSendId'       => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'areasResiveId'     => 'b3db16a5-832a-e311-8b0d-00155d037960',
    'dateSend'          => '12.10.2017',
    'currency'          => 'ua',
    'warehouseSendId'   => 'fa156dd9-9630-e511-9ea9-000d3a200160',
    'warehouseResiveId' => '37548925-0ad3-e411-8a3a-000d3a200160',
)));

getReceipt($number)

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->getReceipt('2130009668'));

getDopUslugi($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->getDopUslugi(array(

    'CitySendId'    => '569983ea-2e2b-e311-8b0d-00155d037960',
    'CityReceiveId' => '47178398-442b-e311-8b0d-00155d037960',
    'currency'      => 'ua',

)));

getTariffList($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();
//$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->getTariffList(array(

    'CitySendId'         => '569983ea-2e2b-e311-8b0d-00155d037960',
    'CityReceiveId'      => '47178398-442b-e311-8b0d-00155d037960',
    'WarehouseReceiveId' => '6bbee295-9575-e611-8104-000d3a204dce',

)));

deliveryScheme($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->deliveryScheme(array(

    'CitySendId'         => '569983ea-2e2b-e311-8b0d-00155d037960',
    'CityReceiveId'      => '47178398-442b-e311-8b0d-00155d037960',
    'WarehouseReceiveId' => '6bbee295-9575-e611-8104-000d3a204dce',

)));

costDelivery($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->costDelivery(array(

    'areasSendId'            => '4fc948a7-3729-e311-8b0d-00155d037960',
    'areasResiveId'          => 'e3ac6f68-3529-e311-8b0d-00155d037960',
    'warehouseSendId'        => '1c828aa6-70c8-e211-9902-00155d037919',
    'warehouseResiveId'      => 'd908c5e1-b36b-e211-81e9-00155d012a15',
    'InsuranceValue'         => 1000000,
    'CashOnDeliveryValue'    => 5000,
    'dateSend'               => '11.10.2017',
    'deliveryScheme'         => 2,
    'category'               => array(
        'categoryId' => '00000000-0000-0000-0000-000000000000',
        'countPlace' => 1,
        'helf'       => 2,
        'size'       => 1,
    ),
    'dopUslugaClassificator' => array(
        'dopUsluga' => array(
            array(
                'uslugaId' => '2b4247c9-be8c-e211-be60-00155d037919',
                'count'    => 1,
            ),
            array(
                'uslugaId' => '3e9cde5d-bf8c-e211-be60-00155d037919',
                'count'    => 5,
            ),
        ),
    ),

)));

newsCompany($count = 5, $page = 1)

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->newsCompany());

themeMessages()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->themeMessages());

sendMessage($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->sendMessage(array(

    'ReceiptNumber' => '123',
    'Name'          => 'Name',
    'Phone'         => '123456',
    'Email'         => '[email protected]',
    'Subject'       => 'Text',
    'Message'       => 'message text',

)));

rateOffice($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->rateCargo(array(

    'OfficeId'               => '1c828aa6-70c8-e211-9902-00155d037919',
    'WarehosePlacing'        => 3,
    'CargoReceiveSpeed'      => 4,
    'CargoOutputSpeed'       => 5,
    'DocumentsIssuanceSpeed' => 6,
    'DeliverySpeed'          => 7,
    'TarrifsRate'            => 8,
    'CargoLoadTarrifs'       => 9,
    'WorkersCulture'         => 10,
    'QualityInGeneral'       => 11,
    'YourRecomendations'     => 'text',
    'ClientNumber'           => '1234567890',
    'Name'                   => 'name',
    'LastName'               => 'last name',
    'SecondName'             => 'second name',
    'Phone'                  => '123456',
    'Email'                  => '[email protected]',
    'CompanyName'            => 'text',

)));

rateCargo($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->rateCargo(array(

    'ContactName' => 'contact name',
    'Name'        => 'name',
    'PhoneNumber' => '123456',
    'Email'       => '[email protected]',
    'Area'        => 'text',
    'City'        => 'text',
    'Address'     => 'text',
    'AccessMode'  => '1',
    'Weight'      => 1,
    'Size'        => 2,
    'Quantity'    => 3,
    'Date'        => '01.10.2017',
    'Time'        => '09:30',
    'Note'        => 'text',
    'IsFloor'     => true,
    'Floor'       => 10,
    'ToCity'      => 'qwe',

)));

auth($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->rateCargo(array(

    'UserName'	=>	'[email protected]',
    'Password'	=>	'password',
    'RememberMe'	=>	true

)));

exitAuth()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAutho->exitAuth());

getUser()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAutho->getUser());

userReceipt($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->userReceipt(array(

    'page' => 1,
    'rows' => 2,
    'type' => 1, //0 - Отправки , 1 - Получения

)));

cardClient()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->cardClient());

invoiceClient()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->invoiceClient());

cargoCategory()

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->cargoCategory());

availableCurrency($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->availableCurrency(array(

    'CitySendId'    => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'CityReceiveId' => 'da5e7df3-a42a-e311-8b0d-00155d037960',
    'PayerType'     => 0,
    'PayerId'       => '',

)));

listPayer($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->listPayer(array(

    'CitySendId'       => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'CityReceiveId'    => '385f7df3-a42a-e311-8b0d-00155d037960',
    'ClientSenderId'   => 'af491888-1429-e311-8b0d-00155d037960',
    'ClientReceiverId' => '6aee3f13-372b-e311-8b0d-00155d037960',
    'PayerType'        => 0,

)));

clientAddress($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->clientAddress(array(

    'CityId'   => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'ClientId' => '385f7df3-a42a-e311-8b0d-00155d037960',

)));

clientAddressPossible($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto('KEY_AUTH', 'KEY_SECRET');

print_r($devAuto->clientAddressPossible(array(

    'CityReceiveId'   => '1e8e7257-a82a-e311-8b0d-00155d037960',
    'ClientSenderId' => '385f7df3-a42a-e311-8b0d-00155d037960',

)));

clientPaymentType($clientID)

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->clientPaymentType('1e8e7257-a82a-e311-8b0d-00155d037960'));

warehousesByCity($data = array())

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->warehousesByCity(array(

    'CityId'        => 'af491888-1429-e311-8b0d-00155d037960',
    'DirectionType' => 0,

)));

getReceiptFull($number)

<?php

use DeliveryAuto\Auto;

include_once __DIR__ . '/vendor/autoload.php';

$devAuto = new Auto();

print_r($devAuto->getReceiptFull('2130009668'));