ipost/php-sdk

PHP-SDK for iPOST API

v1.2.0 2023-03-31 11:11 UTC

Requires

• php: ^7.4|^8.0
• ext-json: *
• guzzlehttp/psr7: ^2.1
• myclabs/php-enum: ^1.8
• psr/http-client: ^1.0
• psr/http-client-implementation: *
• psr/log: ^1.1

Requires (Dev)

• guzzlehttp/guzzle: ^7.0
• monolog/monolog: ^2.3

MIT

• iPOST Devs

• api
• sdk
• ipost
• ipostapi
• ipostsdk

README

Это официальный пакет SDK который в удобном виде предоставляет полный объектно-ориентированный интерфейс для всех методов публичного iPOST REST API и упрощает построения запросов и получения ответов на языке PHP.

Версия API: 1.17

Библиотека содержит SDKClient для правильного построения и отправки запросов, и получения ответов в виде объектов с типизированными полями.

Библиотека также содержит SDKNotify, который получает уведомления от сервера при смене статуса заказа.

Установка

Минимальная версия PHP 7.4

Эта библиотека построена поверх PSR-18 (стандартный интерфейс для реализации HTTP клиента). Поэтому вам нужно будет установить или использовать уже имеющейся в вашем проекте любую реализацию HTTP клиента который использует интерфейс PSR-18.

Если в вашем проекте еще нет клиента PSR-18, или вы не знаете что это, или вам все равно, какой из них использовать, просто установите любой, например:

composer require guzzlehttp/guzzle

Для установки самого SDK выполните команду:

composer require ipost/php-sdk

Быстрый старт

$sdkClient = new SDKClient($yourIpostAccessToken, $httpClient);

$order = $sdkClient->getOrder($orderId);

echo $order->description;

• $sdkClient - содержит все методы для взаимодействия с API.
• $httpClient - это любой PSR-18 совместимый HTTP клиент.
• $yourIpostAccessToken - ваш токен доступа, который вы можете получить в личном кабинете клиента на сайте iPOST.

Используйте автокомплит и подсказки в вашем IDE

Методы SDKClient

• getOrders получения всех ваших заказов с разбивкой на страницы.
• getOrder получения полного описания конкретного заказа.
• createOrder создание заказа.
• previewOrder оценка стоимости доставки.
• updateOrder изменение надбавки к стоимости доставки.
• cancelOrder отмена заказа.
• addReview создание отзыва о курьере.
• updateReview редактирование отзыва.
• deleteReview удаление отзыва.
• getTracking получение текущей геолокации курьера.
• getOrderReviews получение всех отзывов о выполнении заказов.
• getCourierReviews получение всех отзывов о курьере.
• getPaymentCards получение списка привязанных платежных карт.

Методы SDKNotify

• getOrderStatusUpdated получение нового статуса заказа с дополнительной информацией.