Інтерфейс API для використання розумного пошуку товарів інтернет-магазину

Інтерфейс API надає доступ до пошукового серверу, який дозволяє швидко знаходити потрібні товари, що зберігаються в базі даних програмного продукту Elbuz. Можливий пошук товарів та збереження історії пошуку.

Формат обміну, автентифікація

• Для взаємодії використається формат JSON.
• Для запитів використовується метод HTTP GET.
• Для аутентифікації використовується токен (UUID).

Базова інформація

Обмеження доступу

• Доступ до API із зазначенням IP-адрес, з яких можливий доступ.
• За кількістю запитів – не більше 30 з'єднань протягом 60 секунд.

Пагінація – посторінковий висновок

Виведення даних розбивається на сторінки. Максимальна кількість записів за промовчанням 10 записів на одній сторінці. Щоб вказати номер сторінки, використовується параметр «page».

При відповіді формується "meta" інформація, приклад:

    [meta] => 
        (
            [type_search] => product
            [search_value] => праска
            [search_value_corrected] => 
            [total_found] => 1259
            [page_total] => 126
            [page_next] => 1
            [page_current] => 1
            [request_time] => 0. 00052176713943481 sec
        )

Опис meta інформації:

• type_search – тип запиту (product - список товарів, category_product - список товарів згрупований за категоріями)
• search_value – текст для пошуку
• search_value_corrected – текст для пошуку після коригування
• total_found – кількість знайдених товарів
• page_total – загальна кількість сторінок
• page_next – номер наступної сторінки
• page_current – поточна сторінка
• request_time – час, витрачений для отримання інформації

Відбір елементів

Пошук товарів можливий із зазначенням різних полів, наприклад, можна отримати товари лише певної категорії, для цього необхідно передати параметр category_id в якому вказати ID категорії.

Опис роботи з API

Початкова адреса сервісу API: https://адреса_домена_jumper/jsearch/jsearch_api.php
Параметр type приймає код операції, виходячи з якої система розуміє яку операцію необхідно виконати.
Доступні такі значення для параметра type:

• search_product – пошук товарів
• search_category_product – пошук товарів згрупований за категоріями
• log_save_click – збереження історії: клік по товару з результатів пошуку

Приклад посилання для пошуку товарів: https://адреса_домена_jumper/jsearch/jsearch_api.php?type=search_product&search_value=asus

Створення користувача API, отримання токена

Обмін даними через API проводиться з використанням логіну та паролю (токену). Для створення нового користувача API перейдіть до підсистеми "Налаштування"

Потім виберіть "Доступ до API Jumper"

Натисніть кнопку + для створення нового користувача

Опис полів елементів

Для отримання опису полів елементів необхідно отруїти запит POST із зазначенням route=api/scope/describe.
Повна адреса:
https://ваш_адреса_домена/admin/index.php?route=api/scope/describe

Обов'язкові параметри POST:

• api_token - токен отриманий раніше
• scope – код елемента, яким необхідно отримати інформацію. Код елемента можна вказати у посиланні, тоді цей параметр не є обов'язковим.
  
  Список доступних кодів елементів:
  • product – товари базового каталогу
  • product_price – товари з прайс-листів
  • manufacturer – виробники
  • contractor – контрагенти
  • document – документи
  • user – користувачі (співробітники)
  • company – компанії

Приклад реалізації мовою PHP

Розширений приклад роботи з API, мова PHP

Розширені приклади роботи з API з використанням мови PHP доступні за цим посиланням .