- Notifications
You must be signed in to change notification settings - Fork0
📦 Минималистичный HTTP-клиент для работы с API CDEK.
License
chipslays/cdek-api
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
📦 Минималистичный HTTP-клиент для работы сAPI CDEK.
Данная библиотека не предоставляет описание методов API, это простой HTTP-клиент который содержит метод авторизации (получение токена) и методы запроса к API.
Вы должны иметь всегда под рукойдокументацию от СДЕК для сверки с необходимыми методами.
composer require cdek-php/api
Примеры использования библиотеки можно найти в папкеexamples.
useCdek\Client;$client =newClient('EMscd6r9JnFiQ3bLoyjJY6eM78JrJceI','PjLZkKBHEiLK3YsjtNrt3TGNG0ahs3kG');
Пример рабочей тестовой авторизации можно найти в этомпримере.
useCdek\Client;useCdek\Enums\Endpoint;$client =newClient('client-id','client-secret', Endpoint::PROD);
По умолчанию используетсятестовая среда, чтобы начать работать вбоевой среде, необхоимо передать параметрendpoint со значениемCdek\Enums\Endpoint::PROD.
Библиотека поддерживает авторизация с помощью$_ENV, вы можете задать параметры конструктораclient_id,client_secret иendpoint например в .env файле приложения.
# .envCDEK_API_CLIENT_ID=EMscd6r9JnFiQ3bLoyjJY6eM78JrJceICDEK_API_CLIENT_SECRET=PjLZkKBHEiLK3YsjtNrt3TGNG0ahs3kGCDEK_API_ENDPOINT=dev# dev - тестовая среда, prod - боевая среда
// cdek.phpuseCdek\Client;$client =newClient;// без client_id, client_secret и endpoint
Пример авторизации через окружение можно найти в этомпримере.
Токен генерируется при любом запросе к API (они описаны ниже), после чего кэшируется науказанный в ответе срок.
Возвращает действующий токен.
$token =$client->getToken();
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
# https://api-docs.cdek.ru/36982648.html$client->api('get','deliverypoints', ['size' =>10,]);
Выполнить GET-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
# https://api-docs.cdek.ru/36982648.html$client->get('deliverypoints', ['size' =>10,]);
Выполнить POST-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
$client->post(..., [...]);
Выполнить PATCH-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
$client->patch(..., [...]);
Выполнить DELETE-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
$client->delete(..., [...]);
MIT.
About
📦 Минималистичный HTTP-клиент для работы с API CDEK.