Документация по API функции Новой почты: devcenter.novaposhta.ua.
Как подключить библиотеку (SDK):
Создайте файл composer.json в корне Вашeго проекта:
{
"require": {
"serj1chen/nova-poshta-sdk-php": "2.0.*"
}
}
Установите composer:
$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar install
Подключите автолоадер composer:
include_once "vendor/autoload.php";
Перед тем как начать работать с SDK, нужно получить API ключ. Переходим за ссылкой my.novaposhta.ua, заходим под своим логином в личный кабинет. Далее п.м. Налаштування → API 2.0. Нажимаем кнопку Створити новий ключ, копируем созданный ключ.
Настройка SDK:
use NovaPoshta\Config;
Config::setApiKey('<Ваш ключ>');
Config::setFormat(Config::FORMAT_JSONRPC2);
Config::setLanguage(Config::LANGUAGE_UA);
Возможные форматы передачи данных (формат указывать в метод setFormat):
- FORMAT_JSON
- FORMAT_JSONRPC2
- FORMAT_XML
По дефолту будет установлен формат JSONRPC2.
В документации НП работа разбита на модели:
- Address: модель для работы с адресами.
- Common: модель для работы со справочниками.
- ContactPerson: модель для создания контактного лица.
- Counterparty: модель для работы с данными контрагента.
- InternetDocument: модель для оформления отправлений.
- ScanSheet: модель для работы с реестрами приема-передачи отправлений.
Работа с методами модели: save, update, delete. Заполнить модель нужными значениями и вызвать нужный метод. Пример:
use NovaPoshta\ApiModels\Counterparty;
$counterparty = new Counterparty();
$counterparty->setCounterpartyProperty('Recipient');
$counterparty->setCityRef('db5c88d0-391c-11dd-90d9-001a92567626');
$counterparty->setCounterpartyType('PrivatePerson');
$counterparty->setFirstName('Пилипко');
$counterparty->setLastName('Вася');
$counterparty->setMiddleName('Сергеевич');
$counterparty->setPhone('+380661122333');
$counterparty->setEmail('test@i.ua');
$result = $counterparty->save();
Работа с статическими методами. В методы передавать объект MethodParameters:
use NovaPoshta\ApiModels\Counterparty;
use NovaPoshta\MethodParameters\MethodParameters;
$data = new MethodParameters();
$data->CounterpartyProperty = 'Recipient';
$data->Page = 1;
$data->CityRef = '8d5a980d-391c-11dd-90d9-001a92567626';
$data->FindByString = 'Петр';
$result = Counterparty::getCounterparties($data);
Или можно использовать классы MethodParameters, которые наследуются от класса MethodParameters. Классы имеют сеттеры параметров, которые можно передать статическому методу модели. Названия классов с параметрами складываются с двух частей, с названия модели (ApiModels) и названия статического метода модели. Пример использования:
use NovaPoshta\ApiModels\Counterparty;
use NovaPoshta\MethodParameters\MethodParameters;
use NovaPoshta\MethodParameters\Counterparty_getCounterparties;
$data = new Counterparty_getCounterparties();
$data->setCounterpartyProperty('Recipient');
$data->setPage(1);
$data->setCityRef('8d5a980d-391c-11dd-90d9-001a92567626');
$data->setFindByString('Петр');
$result = Counterparty::getCounterparties($data);
Документация по API функциям Укрпочты.
Рассмотрим пример отслеживания отправления на bash
#!/bin/bash
BARCODE=${1-RF846544907UA}
echo ""
echo "Загружается информация об отправлении..."
echo ""
curl -s --data "guid=fcc8d9e1-b6f9-438f-9ac8-b67ab44391dd&barcode=$BARCODE&culture=uk" \http://services.ukrposhta.com/barcodestatistic/barcodestatistic.asmx/GetBarcodeInfo | \sed '/\?xml/ d
/BarcodeInfoService/ d
s/<\/.*.//
s/^.*<barcode>/Номер отправления: /
s/^.*<code>/Код состояния: /
s/^.*<lastofficeindex>/Индекс отделения: /
s/^.*<lastoffice>/Название отделения: /
s/^.*<eventdescription>/Дата: /
s/^.*.*$/Описание события: /
s/^ *//'
exit 0
Вместо идентификатора нужно вставить свой. Именно он будет использоваться при отсутствии аргументов. Если наберете в командной строке «mailtrack CA123456789UA», скрипт вместо RF846544907UA будет искать CA123456789UA.
Пример работы:
$ mailtrack
Загружается информация об отправлении...
Номер отправления: RF846544907UA
Код состояния: 20701
Индекс отделения: 84688
Дата: 24.05.2014
Название отделения: ГОРЛІВКА ЦПЗ № 4
Описание события:
Відправлення за номером RF846544907UA знаходиться в про
цесі оброблення. Востаннє воно зареєстроване 24.05.2014
в об’єкті поштового зв’язку ГОРЛІВКА ЦПЗ № 4 з індексо
м 84688.
| Предыдущий урок | СОДЕРЖАНИЕ | Следующий урок |
