Download the PHP package cdek-php/api without Composer
On this page you can find all versions of the php package cdek-php/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package api
PHP CDEK API v2
📦 Минималистичный HTTP-клиент для работы с API CDEK.
Перед началом работы
Данная библиотека не предоставляет описание методов API, это простой HTTP-клиент который содержит метод авторизации (получение токена) и методы запроса к API.
Вы должны иметь всегда под рукой документацию от СДЕК для сверки с необходимыми методами.
Установка
Примеры
Примеры использования библиотеки можно найти в папке examples.
Документация
Авторизация
Тестовая среда
Пример рабочей тестовой авторизации можно найти в этом примере.
Боевая среда
По умолчанию используется тестовая среда, чтобы начать работать в боевой среде, необхоимо передать параметр endpoint
со значением Cdek\Enums\Endpoint::PROD
.
Авторизация с помощью $_ENV
Библиотека поддерживает авторизация с помощью $_ENV
, вы можете задать параметры конструктора client_id
, client_secret
и endpoint
например в .env файле приложения.
Пример авторизации через окружение можно найти в этом примере.
Токен
Токен генерируется при любом запросе к API (они описаны ниже), после чего кэшируется на указанный в ответе срок.
getToken(): string
Возвращает действующий токен.
Запросы к API
api(string $method, string $endpoint, array $parameters = []): Collection
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
get(string $endpoint, array $parameters = []): Collection
Выполнить GET-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
post(string $endpoint, array $parameters = []): Collection
Выполнить POST-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
patch(string $endpoint, array $parameters = []): Collection
Выполнить PATCH-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
delete(string $endpoint, array $parameters = []): Collection
Выполнить DELETE-запрос к API.
Возвращает объект коллекции (см. документацию по работе с Laravel коллекцией).
Лицензия
MIT.
All versions of api with dependencies
guzzlehttp/guzzle Version ^7.8
symfony/cache Version ^6.4
illuminate/collections Version ^10