Налаштування інтеграції зі SkarbOne

Для початку роботи із застосунком SkarbOne необхідно виконати низку технічних налаштувань. Залежно від вашого поточного статусу, оберіть відповідний сценарій інтеграції:

№	Сценарій	Опис
1	Нова інтеграція через Pharmapoint	Ви новий партнер і тільки починаєте інтеграцію з Pharmapoint та SkarbOne
2	Діюча інтеграція з Pharmapoint	У вас вже налаштована інтеграція з Pharmapoint і ви бажаєте підключити SkarbOne

Нова інтеграція через Pharmapoint

Алгоритм дій для аптечних мереж, які вперше налаштовують інтеграцію через Pharmapoint для роботи з платформою SkarbOne:

1. Команді IT-спеціалістів Вашої аптечної мережі надаються:

• API-ключ;
• технічна документація з описом методів для аптечних мереж.

2. Ваша IT-команда:

• виконує всі необхідні технічні налаштування;
• реалізує імплементацію та застосування наданих API-методів відповідно до документації.

3. Проводиться спільна комунікація з метою:

• тестування реалізованих налаштувань;

• перевірки коректної роботи інтеграції аптечної мережі через Pharmapoint.

4. Після успішного завершення тестування:

• Вашій аптечній мережі надаються всі необхідні доступи до SkarbOne;

• передаються інструкції з встановлення та використання мобільного додатку.

Етапи інтеграції з Pharmapoint

Основний перелік API методів для роботи аптечної мережі доступний за посиланням.

За цим посиланням ви знайдете:

• перелік доступних методів;
• технічні вимоги до запитів;
• рекомендації щодо реалізації інтеграції.

Обов'язкові методи та вимоги для роботи зі SkarbOne

1. Доступи та автентифікація

• Для кожного клієнта створюється окремий обліковий запис

• У всіх API-запитах необхідно передавати такі заголовки:

API-Key: <ваш_API_ключ>
Accept: application/json

інформація

Переконайтесь, що API-ключ активний та використовується у кожному запиті без винятків

2. Вивантаження довідників

№	Довідники	Опис
1	Довідник аптек	Передача переліку всіх торгових точок мережі
2	Довідник товарів	Для роботи з рецептами необхідна прив'язка до бази Pharmapoint: передавайте максимально повні дані за штрихкодами, кодами Моріон та кодами дистриб'юторів
3	Довідник фармацевтів	Передається разом із прив'язкою до аптек для автоматичного створення облікових записів та надання прав доступу в SkarbOne
4	Довідник лікарів	Вивантажується за потреби, якщо потрібне внесення даних лікаря безпосередньо в чек

3. Вивантаження залишків аптеки

№	Залишки	Опис
1	Вивантаження залишків аптеки	Вивантажується для забезпечення актуальності даних про наявність товарів та їх вартість у системі. Для роботи з партіями: у поле drugstore_goods_id передавайте унікальне ID партії (має відрізнятися від goods_id) Для роботи з програмою лояльності: обов'язково заповнюйте поле buy_price_vat (ціна закупівлі товару)
2	Повне вивантаження залишків аптеки	Виконується 1 раз на добу (рекомендовано вночі або рано вранці) для повної актуалізації бази даних аптеки
3	Часткове вивантаження залишків аптеки	Передача лише змінених позицій. Рекомендований інтервал вивантаження — кожні 5-10 хвилин для підтримки актуальних залишків

4. Вивантаження замовлень

№	Замовлення	Опис
1	Замовлення	Синхронізаця статусів замовлень між маркетплейсом, мобільним додатком та вашою обліковою системою
2	Отримання відмінених замовлень	Отримання онлайн-замовлень, які були скасовані в додатку SkarbOne або на маркетплейсі, але попередньо створені в облікой системі. Такі замовлення підлягають обробці та скасуванню в обліковій системі
3	Необроблені замовлення	Отримання всіх необроблених замовлень по аптечній мережі
4	Отримання всіх необроблених замовлень в аптеці	Отримання необроблених замовлень у конкретній аптеці

Статуси замовлень та алгоритм дій з обліковою системою

№	Статус API	Опис
1	created	Нове замовлення. Передано від клієнта в обробку
2	check_by_online_site	Продано онлайн. Клієнт успішно завершив покупку безпосередньо через інтерфейс онлайн-майданчика (мобільного додатка або сайту)
3	canceled_by_marketplace	Скасовано майданчиком. Скасування надійшло ззовні (не з додатка)

інформація

Опис усіх полів, що використовуються в замовленні, міститься на сторінці Оновлення замовлень

Обробка замовлень зі статусом created

При отриманні замовлення зі статусом created аптека повинна:

1. Створити замовлення в системі. Аптека може виконати фіскалізацію замовлення в обліковій системі.

2. Якщо замовлення фіскалізовано в додатку облікова система повинна своєчасно отримати поточний статус замовлення та оновити його (за умови що облікова система підключена до мережі).

Обробка замовлень зі статусом check_by_online_site

При отриманні замовлення зі статусом check_by_online_site аптека повинна:

1. Перевірити наявність замовлення в базі облікової системи за його ідентифікатором (ID).
2. Якщо замовлення відсутнє — створити його.

Важливо!

Створення відбувається без подальшої фіскалізації

3. Прийняти замовлення, обробити всі необхідні поля та викликати метод Оновлення замовлень.
4. Надіслати статус check.

Аптека не буде отримувати ці замовлення в методах отримання необроблених замовлень.

Обробка замовлень зі статусом canceled_by_marketplace

При отриманні замовлення зі статусом canceled_by_marketplace аптека повинна перевірити наявність замовлення в обліковій системі:

• Якщо замовлення є в в обліковій системі - скасувати замовлення в обліковій системі, викликати метод Оновлення замовлень та відправити статус canceled.

• Якщо замовлення відсутнє в обліковій системі - викликати метод Оновлення замовлень та та відправити статус canceled.

Замовлення не потрапляє в необроблені та не передається.

Чек-ліст готовності до запуску

Перед запуском переконайтесь, що виконані всі наступні пункти:

1. Налаштовані всі необхідні HTTP-заголовки.

2. Підключена та перевірена авторизація.

3. Вивантажено:

   • Довідник товарів
   • Довідник аптек
   • Довідник фармацевтів
   • Довідник лікарів (за потреби, якщо лікар зазначається в чеку)

4. Налаштовано:

   • Повне вивантаження залишкыв аптеки.
   • Часткове вивантаження залишків аптеки.
   • Отримання замовлень
   • Оновлення статусів замовлень

5. Успішно пройдені спільні тести в рамках інтеграції Вашої аптечної мережі через Pharmapoint.

Діюча інтеграція з Pharmapoint

Цей сценарій підходить для аптечних мереж, у яких вже налаштована та працює інтеграція з Pharmapoint.

Обов'язкові методи та вимоги для роботи зі SkarbOne

Для коректної роботи SkarbOne необхідно необхідно виконати такі умови:

1. Вивантаження довідників

№	Довідники	Опис
1	Довідник товарів	Для роботи з рецептами необхідна прив'язка до бази Pharmapoint: передавайте максимально повні дані за штрихкодами, кодами Моріон та кодами дистриб'юторів
2	Довідник фармацевтів	Вивантажується з прив'язкою до аптек для автоматичного створення акаунтів та надання доступу в SkarbOne
3	Довідник лікарів	Вивантажується за потреби, якщо потрібне внесення даних лікаря безпосередньо в чек

2. Вивантаження залишків аптеки

№	Залишки	Опис
1	Вивантаження залишків аптеки	Вивантажується для забезпечення актуальності даних про наявність товарів та їх вартість у системі. Для роботи з партіями: у поле drugstore_goods_id передавайте унікальне ID партії (має відрізнятися від goods_id) Для роботи з програмою лояльності: обов'язково заповнюйте поле buy_price_vat (ціна закупівлі товару)

3. Вивантаження замовлень

№	Замовлення	Опис
1	Замовлення	Синхронізаця статусів замовлень між маркетплейсом, мобільним додатком та вашою обліковою системою
2	Отримання відмінених замовлень	Отримання онлайн-замовлень, які були скасовані в додатку SkarbOne або на маркетплейсі, але попередньо створені в облікой системі. Такі замовлення підлягають обробці та скасуванню в обліковій системі
3	Необроблені замовлення	Отримання всіх необроблених замовлень по аптечній мережі
4	Отримання всіх необроблених замовлень в аптеці	Отримання необроблених замовлень у конкретній аптеці

Статуси замовлень та алгоритм дій з обліковою системою

№	Статус API	Опис
1	created	Нове замовлення. Передано від клієнта в обробку
2	check_by_online_site	Продано онлайн. Клієнт успішно завершив покупку безпосередньо через інтерфейс онлайн-майданчика (мобільного додатка або сайту)
3	canceled_by_marketplace	Скасовано майданчиком. Скасування надійшло ззовні (не з додатка)

інформація

Опис усіх полів, що використовуються в замовленні, міститься на сторінці Оновлення замовлень

Обробка замовлень зі статусом created

При отриманні замовлення зі статусом created аптека повинна:

1. Створити замовлення в системі. Аптека може виконати фіскалізацію замовлення в обліковій системі.

2. Якщо замовлення фіскалізовано в додатку облікова система повинна своєчасно отримати поточний статус замовлення та оновити його (за умови що облікова система підключена до мережі).

Обробка замовлень зі статусом check_by_online_site

При отриманні замовлення зі статусом check_by_online_site аптека повинна:

1. Перевірити наявність замовлення в базі облікової системи за його ідентифікатором (ID).
2. Якщо замовлення відсутнє — створити його.

Важливо!

Створення відбувається без подальшої фіскалізації

3. Прийняти замовлення, обробити всі необхідні поля та викликати метод Оновлення замовлень.
4. Надіслати статус check.

Аптека не буде отримувати ці замовлення в методах отримання необроблених замовлень.

Обробка замовлень зі статусом canceled_by_marketplace

При отриманні замовлення зі статусом canceled_by_marketplace аптека повинна перевірити наявність замовлення в обліковій системі:

• Якщо замовлення є в в обліковій системі - скасувати замовлення в обліковій системі, викликати метод Оновлення замовлень та відправити статус canceled.

• Якщо замовлення відсутнє в обліковій системі - викликати метод Оновлення замовлень та та відправити статус canceled.

Замовлення не потрапляє в необроблені та не передається.