Главная страница>Исходный код PHP>Другие категории
Скачать

Стюарт PHP клиент

Для полной документации всех конечных точек, предлагаемых API Stuart, вы можете посетить документацию Stuart API.

Изменение

Посетите ChangeLog

Запуск демонстрации 

 cd demo
docker build -t stuartphpdemo .
export PATH_TO_PROJECT= " /PUT/HERE/YOUR/PATH/TO/PROJECT/stuart-client-php "
docker run -v $PATH_TO_PROJECT /src:/app/vendor/stuartapp/stuart-client-php/src stuartphpdemo

Установить

Через композитор: 

$ composer require stuartapp/stuart-client-php

Использование

  1. Инициализировать клиент
  2. Создать работу
    1. Минималистский
    2. Полный
      1. С расписанием на пикапе
      2. С расписанием при падении
      3. С укладками (мультиплетка)
  3. Получить работу
  4. Отменить работу
  5. Проверить работу
  6. Отменить доставку
  7. Получите цены
  8. Получите работу ETA, чтобы забрать
  9. Пользовательские запросы

Импортировать библиотеку

Если композитор не установлен, установите его: 

$ curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer

Добавьте библиотеку в свой проект: 

$ composer require stuartapp/stuart-client-php

Автозагрузка

Чтобы загрузить все классы из этой библиотеки, просто выполните автозагрузку в начале кода Стюарта 

 <?php
require __DIR__ . ' /vendor/autoload.php ' ;

$ environment =  Stuart  Infrastructure Environment:: SANDBOX ;

Получите учетные данные

Для песочницы (среда тестирования, курьеры - боты) https://dashboard.sandbox.stuart.com/settings/api

Для производства (реальный мир, настоящие курьеры) https://dashboard.stuart.com/settings/api

Инициализировать клиент 

 $ environment =  Stuart  Infrastructure Environment:: SANDBOX ;
$ api_client_id = ' REPLACE_BY_YOU_CLIENT_ID_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ api_client_secret = ' REPLACE_BY_YOUR_CLIENT_SECRET_HERE ' ; // can be found here: https://admin.sandbox.stuart.com/client/api
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret );

$ httpClient = new  Stuart  Infrastructure HttpClient( $ authenticator )

$ client = new  Stuart  Client ( $ httpClient );

Вы также можете передать свой собственный экземпляр клиента Guzze в конструктор StuartHttpClient : 

 $ guzzleClient = new  Guzzle  Client ();
$ httpClient = new  Stuart  Infrastructure  HttpClient ( $ authenticator , $ guzzleClient );

Это может быть полезно, если вам нужно прикрепить Middlewares к клиенту Guzzle.

Кэширование

Настоятельно рекомендуется добавлять механизм кэширования для процесса аутентификации. Для этого просто расширите класс PsrSimpleCacheCacheInterface и реализуйте свою собственную версию.

Есть кэш на основе диска, доступный из коробки для использования. Чтобы использовать его, просто измените инициализацию класса аутентификации и передайте реализацию кэша в конструкторе: 

 $ diskCache = new  Stuart  Cache  DiskCache ( " stuart_cache.txt " );
$ authenticator = new  Stuart  Infrastructure  Authenticator ( $ environment , $ api_client_id , $ api_client_secret , $ diskCache );
Отладка проблем с токеном

Вы можете инициализировать классы DiskCache, Authenticator и HTTPClient, передавая true значение последнему параметру конструктора этих классов.

Создать работу

ВАЖНО : Даже если вы можете создать работу с минимальным набором параметров, мы настоятельно рекомендуем вам заполнить как можно больше информации, чтобы убедиться, что процесс доставки хорошо сочетается.

Минималистский

Размер упаковки на основе 
 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

Полный

Размер упаковки на основе 
 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Pizza box. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique

$ client -> createJob ( $ job );

С расписанием на пикапе

Для получения дополнительной информации о планировании работы вы должны проверить нашу документацию API. 

 $ job = new  Stuart  Job ();

$ pickupAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ pickupAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setPickupAt ( $ pickupAt );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ client -> createJob ( $ job );

С расписанием на высадке

Для получения дополнительной информации о планировании работы вы должны проверить нашу документацию API.

Обратите внимание, что эта функция может использоваться только с одним выпадением. 

 $ job = new  Stuart  Job ();

$ dropoffAt = new  DateTime ( ' now ' , new DateTimeZone ( ' Europe/Paris ' ));
$ dropoffAt -> add ( new  DateInterval ( ' PT2H ' ));

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setDropoffAt ( $ dropoffAt );

$ client -> createJob ( $ job );

С таргетингом флота 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ job -> setFleets ( array ( 1 ));

$ client -> createJob ( $ job );

С конечной информацией о временном окне клиента (используется только для целей метрик) 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ now = new DateTime ();
$ later = new DateTime ();
$ later = $ later -> modify ( ' +15 minutes ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setEndCustomerTimeWindowStart ( new DateTime ())
    -> setEndCustomerTimeWindowEnd ( $ later );

$ client -> createJob ( $ job );

С укладками (мультиплетка)

Размер упаковки на основе 
 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' )
    -> setComment ( ' Wait outside for an employee to come. ' )
    -> setContactCompany ( ' KFC Paris Barbès ' )
    -> setContactFirstName ( ' Martin ' )
    -> setContactLastName ( ' Pont ' )
    -> setContactPhone ( ' +33698348756 ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 3492B. 3e étage droite. Sonner à Durand. ' )
    -> setContactCompany ( ' Durand associates. ' )
    -> setContactFirstName ( ' Alex ' )
    -> setContactLastName ( ' Durand ' )
    -> setContactPhone ( ' +33634981209 ' )
    -> setPackageDescription ( ' Red packet. ' )
    -> setClientReference ( ' 12345678ABCDE ' ); // Must be unique;

$ job -> addDropOff ( ' 12 avenue claude vellefaux, 75010 Paris ' )
    -> setPackageType ( ' small ' )
    -> setComment ( ' code: 92A42. 2e étage gauche ' )
    -> setContactFirstName ( ' Maximilien ' )
    -> setContactLastName ( ' Lebluc ' )
    -> setContactPhone ( ' +33632341209 ' )
    -> setPackageDescription ( ' Blue packet. ' )
    -> setClientReference ( ' ABCDE213124 ' ); // Must be unique

$ client -> createJob ( $ job );

Получить работу

Как только вы успешно создали работу, вы сможете получить ее таким образом: 

 $ jobId = 126532 ;
$ job = $ client -> getJob ( $ jobId );

Или когда вы создаете новую работу: 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ jobWithRoute = $ client -> createJob ( $ job );

$ jobWithRoute -> getDeliveries ();

Стюарт API определяет оптимальный маршрут от вашего имени, поэтому метод getDeliveries() вернет пустой массив, когда работа еще не создана. Метод getDeliveries() вернет массив Delivery , как только будет создана задания.

Отменить работу

Как только вы успешно создали работу, вы сможете отменить ее таким образом: 

 $ jobId = 126532 ;
$ result = $ client -> cancelJob ( $ jobId );

Результат будет удерживать логическое значение true если работа была отменена. Если была ошибка, она будет содержать объект ошибки.

Для получения более подробной информации о том, как работает отмена, пожалуйста, обратитесь к нашему разделу «Выделенная документация».

Проверить работу

Перед созданием работы вы можете проверить ее (контрольная зона доставки и формат адреса). Проверка задания является необязательной и не мешает вам создавать работу. 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ result = $ client -> validateJob ( $ job );

Результат будет содержать логическое значение true если задание действительна. Если была ошибка, она будет содержать объект ошибки.

Проверить адрес

Мы рекомендуем проверить адрес, чтобы выяснить, сможем ли мы забрать / доставить туда. Номер телефона является необязательным только для тех мест, что адрес достаточно конкретный. 

 $ client -> validatePickupAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );
$ client -> validatePickupAddress ( ' Pau Claris 186, 08037 Barcelona ' );
$ client -> validateDropoffAddress ( ' Pau Claris, 08037 Barcelona ' , ' +34677777777 ' );

Отменить доставку

Как только вы успешно создали доставку, вы можете отменить ее таким образом: 

 $ deliveryId = 126532 ;
$ result = $ client -> cancelDelivery ( $ deliveryId );

Получите цены

Перед созданием работы вы можете попросить цены. Запрос о ценах является необязательным и не мешает вам создавать работу. 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ pricing = $ client -> getPricing ( $ job );

$ pricing -> amount ; // example: 11.5
$ pricing -> currency ; // example: "EUR"

Получите работу ETA, чтобы забрать

Перед созданием работы вы можете попросить о предполагаемом времени прибытия в местонахождение (выраженное в секундах). Запрашивать ETA является необязательным и не мешает вам создавать работу. 

 $ job = new  Stuart  Job ();

$ job -> addPickup ( ' 46 Boulevard Barbès, 75018 Paris ' );

$ job -> addDropOff ( ' 156 rue de Charonne, 75011 Paris ' )
    -> setPackageType ( ' small ' );

$ eta = $ client -> getEta ( $ job );

$ eta -> eta ; // example: 672

Пользовательские запросы

Вы также можете отправлять запросы самостоятельно, не полагаясь на StuartClient . Это позволяет использовать конечные точки, которые еще не доступны на StuartClient и наслаждаться StuartAuthenticator . 

 $ apiResponse = $ httpClient -> performGet ( ' /v2/jobs?page=1 ' );
$ apiResponse -> success ();
$ apiResponse -> getBody ();
Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все