README.en.md

Description

Laravel package to work with API Justin

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

Wiki - Description library

Justin API library

Documentation

API documentation

Openapi

Requirements

• PHP 5.6 or above
• Composer
• Laravel
• Justin

Composer

composer require jackmartin/laravel-justin

Laravel setting

After installing the package with composer, register the service package in the file bootstrap/app.php:

JustinLaravel\JustinServiceProvider::class

Then to quickly call the class of the package, add an alias in the same file:

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

Package settings

Copy settings file

php artisan vendor:publish

Select Tag: justin-laravel-config

or

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

Package configuration

Set language response API. Default: UA

language

'language'        => 'UA'

Set sandbox for testing. Default: true

sandbox

'sandbox'         => true

Set version API. Default: v2

version

'version'         => 'v2'

Set orderVersion API. Default: v1

orderVersion

'orderVersion'    => 'v1'

Set timeout return response. Default: 60

timeout

'timeout'         => 60

Set connect_timeout connection server. Default: 60

connect_timeout

'connect_timeout' => 60

Set timezone. Default: UTC

timezone

'timezone'        => 'UTC'

Set auth server login. Default: Exchange

auth_login

'auth_login'      => 'Exchange'

Set auth server password. Default: Exchange

auth_password

'auth_password'   => 'Exchange'

Set key API.

key

'key'             => ''

Set login API.

login

'login'           => ''

Set password API.

password

'password'        => ''

Basic methods API

1. Setup connection
   • __construct
2. Get current status order:
   • currentStatus
3. Get list regions.
   • listRegions
4. Get list regional areas.
   • listAreasRegion
5. Get list settlements.
   • listCities
6. Get list areas of settlements
   • listCityRegion
7. Get list streets city.
   • listStreetsCity
8. Get list types branches
   • branchTypes
9. Get information about department
   • getBranch
10. Get list departments. Old method
    • listDepartments
11. Get list departments.
    • listDepartmentsLang
12. Get schedule work branch
    • branchSchedule
13. Get nearest department by address
    • getNeartDepartment
14. Cancel order
    • cancelOrder
15. Get list statuses order.
    • listStatuses
16. Get key seller(senderID)
    • keySeller
17. Get tracking history
    • trackingHistory
18. Get story statuses order. Old method
    • getStatusHistory
19. Get story statuses order.
    • getStatusHistoryF
20. Create new order(Departure)
    • createOrder
21. Get list orders for specified period
    • listOrders
22. Get information about order
    • orderInfo
23. Create sticker order
    • createSticker

Examples

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()

);