martinjack / laravel-justin

Laravel library Justin API | Laravel пакет для работы с Justin API

Описание

Laravel пакет для работы с API Justin

Read this in other language: English, Русский, Український

Wiki - Описание работы библиотеки

Justin API library

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

API documentation

Openapi

Требования

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

Composer

composer require jackmartin/laravel-justin

Laravel настройка

После установки пакета с помощью composer, зарегистрируйте сервис пакета в файле bootstrap/app.php:

JustinLaravel\JustinServiceProvider::class

Затем для быстрого вызов класса пакета, добавьте псевдоним в этот же файле:

'JustinLaravel' => JustinLaravel\Facades\JustinFacade::class,

Настройка параметров пакета

Копирование файла настроек

php artisan vendor:publish

Выбираем Tag: justin-laravel-config

или

php artisan vendor:publish --provider="JustinLaravel\JustinServiceProvider" --tag="justin-laravel-config"

Конфигурация пакета

Передать язык ответа сервера. По умолчанию: UA

language

'language'        => 'UA'

Песочница. По умолчанию: true

sandbox

'sandbox'         => true

Версия API. По умолчанию: v2

version

'version'         => 'v2'

Версия Order API. По умолчанию: v1

orderVersion

'orderVersion'    => 'v1'

Тайм-аут, на возврат ответа от сервера. По умолчанию: 60 секунд

timeout

'timeout'         => 60

Тайм-аут, на подключение к серверу. По умолчанию: 60 секунд

connect_timeout

'connect_timeout' => 60

Часовой пояс. По умолчанию: UTC

timezone

'timezone'        => 'UTC'

Логин авторизации на сервер. По умолчанию: Exchange

auth_login

'auth_login'      => 'Exchange'

Пароль авторизации на сервер. По умолчанию: Exchange

auth_password

'auth_password'   => 'Exchange'

Ключ API.

key

'key'             => ''

Логин API.

login

'login'           => ''

Пароль API.

password

'password'        => ''

Основные методы API

1. Настройка подключения
   • __construct
2. Получить текущий статус заказа:
   • currentStatus
3. Получить список областей
   • listRegions
4. Получить список областных районов
   • listAreasRegion
5. Получить список населенных пунктов
   • listCities
6. Получить список районов населенных пунктов
   • listCityRegion
7. Получить список улиц города
   • listStreetsCity
8. Получить список типов отделений
   • branchTypes
9. Получить информацию про отделение
   • getBranch
10. Получить список отделений. Старый метод
    • listDepartments
11. Получить список отделений.
    • listDepartmentsLang
12. Получить расписание работы отделения
    • branchSchedule
13. Получить ближайшее отделение по адресу
    • getNeartDepartment
14. Создать новый заказ(Отправление)
    • createOrder
15. Отмена заказа
    • cancelOrder
16. Получить список статусов заказа
    • listStatuses
17. Получить ключ торговца(senderID)
    • keySeller
18. Получить историю движения отправления
    • trackingHistory
19. Получить историю статусов заказа. Старый метод
    • getStatusHistory
20. Получить историю статусов заказа.
    • getStatusHistoryF
21. Получить список заказов за указанный период
    • listOrders
22. Получить информацию о заказе
    • orderInfo
23. Создать стикер заказа
    • createSticker

Примеры

listRegions()

print_r(

    \JustinLaravel::listRegions()->getData()
    // (new \JustinLaravel())->listRegions()->getData()

);

listCities()

print_r(

    \JustinLaravel::listCities()->getData()
    // (new \JustinLaravel())->listCities()->getData()

);

getBranch()

print_r(

    (new JustinLaravel())->getBranch('220')->getData()
    // (new JustinLaravel())->getBranch('220')->fields()->number()
    // (new JustinLaravel())->getBranch('220')->fields()->getType()
    // (new JustinLaravel())->getBranch('220')->fields()->address()
    // (new JustinLaravel())->getBranch('220')->fields()->getPosition()
    // (new JustinLaravel())->getBranch('220')->fields()->getDescr()
    // (new JustinLaravel())->getBranch('220')->fields()->scheduDescr()

);