Download the PHP package bravegeek/allrival-sdk without Composer
On this page you can find all versions of the php package bravegeek/allrival-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bravegeek/allrival-sdk
More information about bravegeek/allrival-sdk
Files in bravegeek/allrival-sdk
Package allrival-sdk
Short Description An SDK designed for easy usage of the allrival.com website's API
License MIT
Homepage https://github.com/BraveGeek3/allrival-sdk
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 allrival-sdk
Allrival-SDK
An SDK designed for easy usage of the allrival.com website's API
SKD созданное для упрощенного взаимодействия с API сайта allrival.com
Документация к API
Установка
Клиент
Класс AllrivalSDK\Client.php является точкой входа для взаимодействия с SDK.
В нем находятся менеджеры, через которых идет взаимодействие с API Allrival.
Менеджеры
В данном SDK представлены 5 типов менеджеров:
- Product Manager
- Company Manager
- Cluster Manager
- Report Manager
- Price history Manager
1) Product Manager отвечает за добавление и удаление товаров. При передачи url
уже сохраненного товара сервер вернет полную информацию о нем.
Методы:
- addProduct
Принимает Url товара, который вы хотите сохранить. Возвращает информацию о сохраненном товаре
Примеры: - deleteProduct
Принимает Url товара, который вы хотите удалить. Возвращает булево значение о результате удаления (true/false)
2) Company Manager отвечает за получение всей информации о компании и её конкурентах на сайте Allrival а также удаление компании вместе с продуктами по её ID
Методы:
- getYourCompanyInfo
Возвращает информацию о вашей компании и её конкурентах
Примеры: - removeProductsByCompanyId
Удаляет компанию вместе с продуктами по её ID
3) Cluster Manager отвечает за создание/удаление сопоставлений по ID Вашего продукта и ID продукта конкурента.
Если будут переданы неправильные ID продуктов (оба ID вашей компании, оба ID компании конкурента) менеджер выкинет BadRequestException с информацией о неправильных ID.
Методы:
- createMatching
Принимает параметры ID продукта вашей компании и ID продукта компании конкурента.
В случае успеха, возвращает о созданном сопоставлении.
- deleteMatching
Принимает параметры ID продукта вашей компании и ID продукта компании конкурента.
В случае успеха, возвращает об удаленном сопоставлении.
4) Report Manager - отвечает за выгрузку. Принимает фильтры, которые будут использованы при выборке.
Методы:
- getYourProducts
Принимает произвольное количество фильтров и возвращает выгрузку ваших продуктов на основе фильтров. - getRivalProducts
Принимает произвольное количество фильтров и возвращает выгрузку продуктов конкурентов на основе фильтров. - getSimilars
Принимает произвольное количество фильтров и возвращает выгрузку сопоставлений ваших товаров с товарами конкурентов на основе фильтров. - setFilters
Сохраняет переданные фильтры для использования в последующих запросах - addFilter
Добавляет переданный фильтр к массиву уже сохраненных фильтров - removeFilter
Удаляет переданный фильтр из массива уже сохраненных фильтров по его названию - replaceFilter
Заменяет существующий сохраненный фильтр переданным - resetFilters
Очищает сохраненные фильтры, добавленные через setFilters()
Фильтры
Каждый фильтр наследуется от соответствующего типа фильтра. Существует 8 видов фильтров: 1) BooleanFilter - Фильтр для булевых типов фильтров (где есть выбор да/нет) 2) EmptyTypeFilter - Без указания типа фильтра, принимает только явные значения 3) EmptyTypeMultipleValuesFilter - Для фильтров с выбором нескольких значений (тэги, города, категории и т.д.) и без типа фильтра 4) InequalityFilter - Фильтр для сравнения числовых значений 5) MembershipFilter - Фильтр для строковых значений. Позволяет указать принадлежит ли одна строка другой или сравнить их 6) MultipleValuesFilter - Для типов фильтров с выбором нескольких значений (города, категории и компании) с выбором типа фильтра 7) OnlyExplicitValuesFilter - Фильтр без указания типа, принимает только явные значения. Примеры параметров можно посмотреть в личном кабинете allrival.com 8) TimePeriodFilter - Фильтр для работы с датой и временем
Примеры
- Получение ваших товаров на основе фильтров
- Добавление и удаление товаров
- Получение истории цен
- Создание и удаление сопоставлений
Больше примеров использования находятся в папке ./tests
All versions of allrival-sdk with dependencies
ext-curl Version *
ext-json Version *