-
2
Опис файлу
Модифікатор додає можливість здійснювати "GET" запити через API, для отримання нових, не оброблених замовлень.
Тобто замовлень, які мають Статус "Очікування" або "В обробці".
Також додана можливість вводити IP адресу користувачів, яким дозволен доступ до API, у вигляді маски використовуючи "*".
ВСТАНОВЛЕННЯ
Через установник доповнень оперкарт.
Після встановлення почистити кеш модифікаторів.
НАЛАШТУВАННЯ
Після встановлення модифікатора, якщо потрібно, можна додати користувача API.
Для цього в адмін панелі вибрати "Система > Користувачі > API" та натиснути кнопку "Додати".
У формі, що з'явилася, ввести Ім'я і Ключ (або згенерувати його) і змінити Статус на "Увімкнено",
а також у вкладці IP-адреси додати адресу або сиписок адрес, яким буде дозволений доступ до API.
Можна додати адресу у вигляді маски, використовуючи "*" (наприклад 192.168.*.*).
ТЕСТУВАННЯ
Тепер можна розпочати запити через API.
1. Oтримуємо API-Token, використовуючи Ім'я і Ключ:
https://you.site.url/index.php?route=api/login&api_username=API-USER&api_key=API-KEY
або, якщо використовується Ім'я за умовчанням (Default), то тільки Ключ цього користувача:
https://you.site.url/index.php?route=api/login&api_key=API-KEY
Якщо запит пройшов успішно, то отримайте таку відповідь:
{"success":"true","api_token":"a4cf14c8c106cb0ab95c96b2ce","error":""}
копіюємо API-Токен, він знадобиться для доступу до інформації про замовлення.
Якщо ні, то можливі два варіанти відповіді:
{"success":"false","api_token":"","error":"Incorrect API username or key!"}
або
{"success":"false","api_token":"","error":"Your IP 192.169.12.1 does not have access to the API!"}
2. Використовуючи API-Токен, робимо запит для отримання необроблених ордерів:
https://you.site.url/index.php?route=api/sale/orders&api_token=a4cf14c8c106cb0ab95c96b2ce
отримуємо відповідь, наприклад:
{"success":"true","orders":[{"order_id":"1","customer":"Test Test","date_added":"09\/06\/2024 11:41:54","total":"500.00 \u0433\u0440\u043d."}],"orders_total":1,"sale_total":500,"error":""}
3. Тепер знаючи номер нового замовлення робимо запит про його повну інформацію:
https://you.site.url/index.php?route=api/sale/order&api_token=a4cf14c8c106cb0ab95c96b2ce&order_id=1
відповідь:
{"success":"true","order_info":"- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\u2116 \u0437\u0430\u043c\u043e\u0432\u043b\u0435\u043d\u043d\u044f: 1\n\u0414\u0430\u0442\u0430 \u0437\u0430\u043c\u043e\u0432\u043b\u0435\u043d\u043d\u044f: 09\/06\/2024 11:41:54\n\u0406\u043c\u044f: \u0428\u0432\u0438\u0434\u043a\u0438\u0439 \u0437\u0430\u043a\u0430\u0437\n\u0422\u0435\u043b\u0435\u0444\u043e\u043d: 0987654321\n- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\nMacBook\n\u041a\u043e\u0434 \u0442\u043e\u0432\u0430\u0440\u0443: Product 16 \u041a\u0456\u043b\u044c\u043a\u0456\u0441\u0442\u044c: 1\n\n\u0420\u0430\u0437\u043e\u043c: 500.00 \u0433\u0440\u043d.\n- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n\u0411\u0430\u043d\u043a\u0456\u0432\u0441\u044c\u043a\u0456\u0439 \u043f\u0435\u0440\u0435\u043a\u0430\u0437\n\n- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -\n","error":""}
Для зручності тестування, щоб уникнути ручної роботи, в архіві testing-api.zip знаходиться файл "index.html",
за допомогою якого все вище описане робиться просто і наочно.
