Робота з АРІ
API Епіцентр Маркетплейс - це можливість інтегруватися з вашою системою для швидкого обміну інформацією по замовленням.
ВАЖЛИВО! Доступ до генерування токену є тільки у ролі Адміністратор компанії, якщо ваша роль Менеджер компанії, напишіть на Підтримку для заміни.
Зміна статусів та даних в замовлені має проходити відповідно до встановлених правил платформи. Нижче вказані інструкції з обробки замовлень:
Зверніть увагу: якщо замовлення з певних причин знаходиться в одному з проміжних статусів ("Підтверджено продавцем", "Підтверджено", "Відправлено", "Готове до видачі") впродовж 21 дня, після завершення цього терміну його статус буде автоматично змінено на Завершено.
Далі у вас буде 5 днів на оскарження зміни статусу — у випадку, якщо замовлення не було виконано і його необхідно скасувати, вам потрібно оформити відповідний запит у Підтримку з відповідною тематикою.
Якщо автоматичне переведення замовлення у статус Завершено не буде оскаржено впродовж 5 днів, його статус зміниться на Закрито і буде списано комісію як за успішно виконане.
Підключення до АРІ
Генерування токену для роботи з АРІ
Після цього вам стане доступною нова вкладка "API" у розділі "Налаштування"- "Налаштування компанії".
У вкладці "API" буде відображена коротка інформація про можливості API та блок для генерування токену.
Щоб згенерувати токен, натисніть кнопку "Згенерувати". Активний токен відобразиться у відповідному полі.
Ви маєте можливість скопіювати його, натиснувши на іконку справа від поля, та передати своєму технічному спеціалісту.
Якщо вам необхідно згенерувати додатковий токен, натисніть "Оновити ключ". З'явиться вспливаюче вікно для підтвердження дії.
Якщо ви впевнені, що вам потрібно оновити токен, натисніть "ТАК". Новий ключ буде відображено замість попереднього, а перший згенерований - у блоці "Активні токени".
ВАЖЛИВО! Токени не мають терміну дії та активні до тих пір, поки ви їх не видалите.
Якщо вам потрібно деактивувати один з ключів, видаліть його зі списку, натиснувши на іконку кошика.
Токен буде видалено з активних ключів, обмін стане недоступним.
ВАЖЛИВО! Робота з АРІ передбачає, що у вашому штаті є технічний спеціаліст, який виконає всі інтеграції.
Обов'язково надайте своєму технічному спеціалісту посилання на Swagger з описом методів обміну,
Приклад запиту:
Оновити дані клієнта
METHOD POSThttps://merchant-api.epicentrm.com.ua/v2/oms/orders/{orderId}/client-data
Example Value
{
"firstName": "John",
"lastName": "Galt",
"patronymic": "Willson",
"email": "test@test.com",
"phone": "380661112233"
}
Після запиту ви отримаєте успішне виконання змін даних, або код помилки
Responses
202
Successful operation
Responses
404
The specified resource was not found
Example Value
{
"message": "string",
"code": 0
}
Часті Питання
Нижче ми зібрали питання та відповіді на них, щоб скоріше зорієнтуватися вам по доступному функціоналу.
Чи є у вас інтеграція з CRM-платформами?
Наразі в нас доступне тільки відкрите API, яке ви можете інтегрувати самостійно до вашої системи
Ми розглядаємо в майбутньому інтеграції з платформами. Окремо ми опублікуємо новину, які перші платформи будуть використовувати наше АПІ по обробці замовлень
Чи є у вас обмін цін та залишків?
Наразі доступне API лише для обробки замовлень. Про розширення можливостей ми обов’язково сповістимо через наші канали в телеграм та email-розсилкою
Чи є у вас спеціаліст, який би допоміг мені в інтеграції?
Ми надаємо тільки доступ до документації. Інтеграцію ви здійснюєте самостійно
Де знайти orderId для виконання запиту на отримання інформації?
orderId - це унікальний ідентифікатор замовлення, зазначений у форматі uuid.
Щоб дізнатися orderId конкретного замовлення, зайдіть в кабінет, відкрийте детальну картку замовлення і скопіюйте в адресному рядку самий останній сегмент - це і буде orderId.
https://admin.epicentrm.com.ua/oms/orders/d9f191d5-c945-f5r6-84f3-3afe59287a43
Як отримати список відділень, щоб змінити дані в способі доставки?
Всі методи отримання та обміну даними ви можете знайти у Swagger https://merchant-api.epicentrm.com.ua/swagger/
Кожен метод має короткий опис.
Як змінити статус замовлення?
Для зміни статусу ви маєте використовувати метод POST /v2/oms/orders/{orderId}/change-status/to/{orderStatus}.
Тіло запиту заповнюється лише в двох випадках. При переводі замовлення в:
- Скасовано - вказати причину скасування
- Відправлено - вказати номер ТТН
В мене вибиває помилку на отримання даних, куди звернутися?
Для правильної відповіді на ваше питання, напишіть, будь ласка, на пошту нашої Підтримки merchant@epicentrk.ua .
- В темі листа вкажіть: Робота з API «назва магазину»
- В тілі опишіть проблему з методом
- Обов’язково прикріпіть скрін помилки для пришвидшення виявлення проблеми
Чи можу я згенерувати собі 2 ключі, і щоб вони були активні?
Так, в налаштуваннях компанії у вкладці API ви генеруєте ту кількість ключів, яка вам необхідна. Якщо ключ потрібно деактивувати, видаліть його і обмін стане недоступний.
Ви маєте бути власником компанії з повним доступом, щоб була можливість згенерувати токен
Чи є у вас тестове середовище, де я можу спробувати?
Ми надаємо доступ тільки до прод-версії. Наразі тестового середовища немає. Всі зміни, що ви робите через API відразу будуть відображатися в кабінеті
ПОВ'ЯЗАНІ СТАТТІ
