Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 18 additions & 128 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,192 +59,90 @@ require '<path_to_dir>/src/Delivery/NovaPoshtaApi2.php';
Класс по умолчанию находится в namespace `\LisDev\Delivery`. При создании экземпляра класса необходимо
или использовать Full Qualified Class Name:
```php
$np = new \LisDev\Delivery\NovaPoshtaApi2('Ваш_ключ_API_2.0');
$np = new \LisDev\NovaPoshtaClient(['apiKey' => 'Ваш_ключ_API_2.0']);
```
или указать используемый namespace в секции use:
```php
use LisDev\Delivery\NovaPoshtaApi2;
use LisDev\NovaPoshtaClient;
...
$np = new NovaPoshtaApi2('Ваш_ключ_API_2.0');
$np = new NovaPoshtaClient(['apiKey' => 'Ваш_ключ_API_2.0']);
```

Более подробную информацию по работе с namespace можно получить [на сайте документации php](https://www.php.net/manual/ru/language.namespaces.rationale.php)

## Создание экземпляра класса (с расширенными параметрами)
Рекомендуется использовать, если необходимо получать данные на языке, отличном от русского, выбрасывать Exception при ошибке запроса, или при отсутствии установленной библиотеки curl на сервере
```php
$np = new NovaPoshtaApi2(
'Ваш_ключ_API_2.0',
'ru', // Язык возвращаемых данных: ru (default) | ua | en
FALSE, // При ошибке в запросе выбрасывать Exception: FALSE (default) | TRUE
'curl' // Используемый механизм запроса: curl (defalut) | file_get_content
$np =new NovaPoshtaClient([
'apiKey' => 'YOUR_KEY',
'language' => \LisDev\Language::Ru,
'format' => \LisDev\DataFormat::Json,
'connectionType' => \LisDev\ConnectionType::Curl,
'throwErrors' => false
);
```

## Получение информации о трек-номере
```php
$result = $np->documentsTracking('59000000000000');
$result = $np->trackingDocument->documentsTracking('59000000000000');
```

## Получение сроков доставки
```php
// Получение кода города по названию города и области
$sender_city = $np->getCity('Белгород-Днестровский', 'Одесская');
$sender_city = $np->address->getCity('Белгород-Днестровский', 'Одесская');
$sender_city_ref = $sender_city['data'][0]['Ref'];
// Получение кода города по названию города и области
$recipient_city = $np->getCity('Киев', 'Киевская');
$recipient_city = $np->address->getCity('Киев', 'Киевская');
$recipient_city_ref = $recipient_city['data'][0]['Ref'];
// Дата отправки груза
$date = date('d.m.Y');
// Получение ориентировочной даты прибытия груза между складами в разных городах
$result = $np->getDocumentDeliveryDate($sender_city_ref, $recipient_city_ref, 'WarehouseWarehouse', $date);
$result = $np->internetDocument->getDocumentDeliveryDate($sender_city_ref, $recipient_city_ref, 'WarehouseWarehouse', $date);
```
## Получение стоимости доставки
```php
// Получение кода города по названию города и области
$sender_city = $np->getCity('Белгород-Днестровский', 'Одесская');
$sender_city = $np->address->getCity('Белгород-Днестровский', 'Одесская');
$sender_city_ref = $sender_city['data'][0]['Ref'];
// Получение кода города по названию города и области
$recipient_city = $np->getCity('Киев', 'Киевская');
$recipient_city = $np->address->getCity('Киев', 'Киевская');
$recipient_city_ref = $recipient_city['data'][0]['Ref'];
// Вес товара
$weight = 7;
// Цена в грн
$price = 5450;
// Получение стоимости доставки груза с указанным весом и стоимостью между складами в разных городах
$result = $np->getDocumentPrice($sender_city_ref, $recipient_city_ref, 'WarehouseWarehouse', $weight, $price);
```
## Генерирование новой электронной накладной
```php
// Перед генерированием ЭН необходимо получить данные отправителя
// Получение всех отправителей
$senderInfo = $np->getCounterparties('Sender', 1, '', '');
// Выбор отправителя в конкретном городе (в данном случае - в первом попавшемся)
$sender = $senderInfo['data'][0];
// Информация о складе отправителя
$senderWarehouses = $np->getWarehouses($sender['City']);
// Генерирование новой накладной
$result = $np->newInternetDocument(
// Данные отправителя
array(
// Данные пользователя
'FirstName' => $sender['FirstName'],
'MiddleName' => $sender['MiddleName'],
'LastName' => $sender['LastName'],
// Вместо FirstName, MiddleName, LastName можно ввести зарегистрированные ФИО отправителя или название фирмы для юрлиц
// (можно получить, вызвав метод getCounterparties('Sender', 1, '', ''))
// 'Description' => $sender['Description'],
// Необязательное поле, в случае отсутствия будет использоваться из данных контакта
// 'Phone' => '0631112233',
// Город отправления
// 'City' => 'Белгород-Днестровский',
// Область отправления
// 'Region' => 'Одесская',
'CitySender' => $sender['City'],
// Отделение отправления по ID (в данном случае - в первом попавшемся)
'SenderAddress' => $senderWarehouses['data'][0]['Ref'],
// Отделение отправления по адресу
// 'Warehouse' => $senderWarehouses['data'][0]['DescriptionRu'],
),
// Данные получателя
array(
'FirstName' => 'Сидор',
'MiddleName' => 'Сидорович',
'LastName' => 'Сиродов',
'Phone' => '0509998877',
'City' => 'Киев',
'Region' => 'Киевская',
'Warehouse' => 'Отделение №3: ул. Калачевская, 13 (Старая Дарница)',
),
array(
// Дата отправления
'DateTime' => date('d.m.Y'),
// Тип доставки, дополнительно - getServiceTypes()
'ServiceType' => 'WarehouseWarehouse',
// Тип оплаты, дополнительно - getPaymentForms()
'PaymentMethod' => 'Cash',
// Кто оплачивает за доставку
'PayerType' => 'Recipient',
// Стоимость груза в грн
'Cost' => '500',
// Кол-во мест
'SeatsAmount' => '1',
// Описание груза
'Description' => 'Кастрюля',
// Тип доставки, дополнительно - getCargoTypes
'CargoType' => 'Cargo',
// Вес груза
'Weight' => '10',
// Объем груза в куб.м.
'VolumeGeneral' => '0.5',
// Обратная доставка
'BackwardDeliveryData' => array(
array(
// Кто оплачивает обратную доставку
'PayerType' => 'Recipient',
// Тип доставки
'CargoType' => 'Money',
// Значение обратной доставки
'RedeliveryString' => 4552,
)
)
)
);
$result = $np->internetDocument->getDocumentPrice($sender_city_ref, $recipient_city_ref, 'WarehouseWarehouse', $weight, $price);
```
## Получение складов в определенном городе
```php
// В параметрах указывается город и область (для более точного поиска)
$city = $np->getCity('Киев', 'Киевская');
$result = $np->getWarehouses($city['data'][0]['Ref']);
```
## Вызов произвольного метода
```php
$result = $np
->model('Имя_модели')
->method('Имя_метода')
->params(array(
'Имя_параметра_1' => 'Значение_параметра_1',
'Имя_параметра_2' => 'Значение_параметра_2',
))
->execute();
$city = $np->address->getCity('Киев', 'Киевская');
$result = $np->address->getWarehouses($city['data'][0]['Ref']);
```

# Реализованные методы для работы с моделями

## Модель InternetDocument
* save
* update
* delete
* getDocumentPrice
* getDocumentDeliveryDate
* getDocumentList
* getDocument
* printDocument
* printMarkings
* documentsTracking
* newInternetDocument
* generateReport

## Модель Counterparty
* save
* update
* delete
* cloneLoyaltyCounterpartySender
* getCounterparties
* getCounterpartyAddresses
* getCounterpartyContactPersons
* getCounterpartyByEDRPOU
* getCounterpartyOptions

## Модель ContactPerson
* save
* update
* delete

## Модель Address
* save
* update
* delete
* getCities
* getStreet
* getWarehouses
Expand All @@ -267,11 +165,3 @@ $result = $np
* getTypesOfPayers
* getTypesOfPayersForRedelivery

# Тесты
Актуальные тесты и примеры использования класса находятся в файле `tests/NovaPoshtaApi2Test.php`

Для запуска тестов локально необходимо выполнить в командной строке
```
composer install
NOVA_POSHTA_API2_KEY=Ваш_ключ_API_2.0 vendor/phpunit/phpunit/phpunit tests
```
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@
}
],
"require": {
"php": ">=5.3.0"
"php": ">=8.1",
"ext-simplexml": "*",
"ext-mbstring": "*"
},
"require-dev": {
"phpunit/phpunit": "~4.4"
Expand Down
30 changes: 30 additions & 0 deletions src/ApiDefaultDataPreparator.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

namespace LisDev;

class ApiDefaultDataPreparator implements DataPreparatorInterface
{

public function prepare(bool|array|string $data, DataFormat $format, bool $throwErrors): mixed
{
// Returns array
if (DataFormat::Array === $format) {
$result = is_array($data)
? $data
: json_decode($data, true);
// If error exists, throw Exception
if ($throwErrors and array_key_exists('errors', $result) and $result['errors']) {
throw new \Exception(
is_array($result['errors']) ? implode("\n", $result['errors']) : $result['errors']
);
}

return $result;
}

// Returns json or xml document
return $data;
}
}
106 changes: 106 additions & 0 deletions src/ApiRequestor.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<?php

declare(strict_types=1);

namespace LisDev;

class ApiRequestor
{
public function __construct(private string $apiKey, private string $apiUrl, private array $config)
{
}

public function request(string $model, string $method, array $params = null): bool|array|string
{
$url = $this->prepareUrl();
$data = $this->prepareData($model, $method, $params);
$result = [];
if ($this->config['format'] === DataFormat::Xml) {
$post = $this->arrayToXml($data);
} else {
$post = json_encode($data);
}

if (ConnectionType::Curl === $this->config['connectionType']) {
$ch = curl_init($url);
if (is_resource($ch)) {
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt(
$ch,
CURLOPT_HTTPHEADER,
['Content-Type: '.(DataFormat::Xml === $this->config['format'] ? 'text/xml' : 'application/json')]
);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);

if ($this->timeout > 0) {
curl_setopt($ch, CURLOPT_TIMEOUT, $this->timeout);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->timeout);
}

$result = curl_exec($ch);
curl_close($ch);
}
} else {
$httpOptions = [
'method' => 'POST',
'header' => "Content-type: application/x-www-form-urlencoded;\r\n",
'content' => $post,
];

if ($this->config['timeout'] > 0) {
$httpOptions['timeout'] = $this->config['timeout'];
}

$result = file_get_contents(
$url,
false,
stream_context_create(array(
'http' => $httpOptions,
))
);
}

return $result;
}

private function prepareUrl(): string
{
return ($this->config['format'] === DataFormat::Xml) ? $this->apiUrl.'/xml/' : $this->apiUrl.'/json/';
}

private function prepareData(string $model, string $method, ?array $params): array
{
return [
'apiKey' => $this->apiKey,
'modelName' => $model,
'calledMethod' => $method,
'language' => $this->config['language']->value,
'methodProperties' => $params,
];
}

/**
* @param array $array
* @param \SimpleXMLElement|null $xml
* @return bool|string
*/
private function arrayToXml(array $array, \SimpleXMLElement $xml = null): bool|string
{
(null === $xml) and $xml = new \SimpleXMLElement('<root/>');
foreach ($array as $key => $value) {
if (is_numeric($key)) {
$key = 'item';
}
if (is_array($value)) {
$this->arrayToXml($value, $xml->addChild($key));
} else {
$xml->addChild($key, $value);
}
}

return $xml->asXML();
}
}
Loading