Download the PHP package vgrish/yclients-sdk-php without Composer
On this page you can find all versions of the php package vgrish/yclients-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package yclients-sdk-php
yclients-sdk-php
SDK для работы с API v1.0 сервиса Yclients
Библиотека является оберткой для пакета YclientsOpenApi
, позволяющая работать с Yclients API и PHP 8.1+.
Находится в разработке, версии могут не обладать обратной совместимостью. Список изменений можно найти в Changelog.
Установка
Быстрый старт
Особенности
Библиотека предоставляет конструктор запросов (Query) для работы с API.
Конструктор запросов
Позволяет при помощи fluent-цепочки методов собрать запрос к API Yclients.
Конструктор запросов вызывается при помощи метода query() базового объекта библиотеки.
Методы формирования запроса
Сегменты
Делятся на два вида:
endpoint- первый сегмент в запросе послеquery(). Примеры:clients(),loyalty().segment- сегменты, следующие послеendpoint. Примеры:auth(),card().
Сегменты могут иметь набор различных вложенных сегментов и методов которыми обладает сущность, представляемая сегментом.
Путь запроса
path()метод для формирования параметров пути запроса. Несколько параметров можно применить, вызвав метод несколько раз, или при помощи массива.
Параметры запроса
-
param()метод для формирования параметров запроса. Несколько параметров можно применить, вызвав метод несколько раз, или при помощи массива. page($value)- установка страницы пагинации.count($value)- установка кол-ва результатов выборки.pageSize($value)- установка кол-ва результатов выборки. (у разнах сущностей разные параметры запроса)
Методы отправки запросов
Запрос ($request) можно передавать напрямую в метод запроса в формате array.
-
create($request)-POSTзапрос для создания сущности. -
get($request)-GETзапрос для получения сущности. -
update($request)-PUTзапрос для обновления сущности. remove($request)-DELETEзапрос для удаления сущности.
Итерация результатов
Объекты коллекции можно получить с помощью objects(). Таким образом, перебор полученного результата можно организовать следующим образом:
Однако, если нужно перебрать всю коллекцию, размер которой больше лимита, коллекцию придётся запрашивать несколько раз,
изменяя параметр page.
Чтобы не организовывать такой перебор вручную, можно использовать метод generator(). Он возвращает генератор,
перебирающий коллекцию с текущего page и до последнего элемента (с отправкой новых запросов, если это необходимо).
All versions of yclients-sdk-php with dependencies
ext-curl Version *
ext-json Version *
vgrish/yclients-openapi-php Version 1.0.1