Перелік методів API

Усі запити до API Pharmapoint повинні надсилатися на наступний базовий URI:

URI: https://pharmapoint.ua

На цій сторінці наведено перелік методів API з коротким описом. Детальні параметри запиту та відповіді — на сторінках окремих методів.

Спочатку оберіть свою аудиторію в списку нижче або в боковому меню (аптечні мережі, страхові компанії, онлайн-бронювання, компанії).

Перед інтеграцією ознайомтесь із технічними вимогами.

Для аптечних мереж

Призначення: вивантаження довідників, замовлення, лояльність, eHealth-дані рецепту.

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

Залишки аптеки

• POST /api/v1/marketplace/stock/{drugtsore_id}/import/full — Повне вивантаження залишків аптеки
• POST /api/v1/marketplace/stock/{drugstore_id}/import/partial — Часткове вивантаження залишків аптеки

Довідники

• POST /api/v1/marketplace/drugstore/import — Вивантаження довідника аптек
• POST /api/v1/marketplace/goods/import — Вивантаження довідника товарів
• POST /api/v1/marketplace/goods/categories/import — Вивантаження категорії товарів
• POST /api/v1/marketplace/price-list/import — Вивантаження прайс-листів
• POST /api/v1/marketplace/users/import— Вивантаження довідника фармацевтів
• POST /api/v1/marketplace/doctors/import— Вивантаження довідника лікарів

Статус вивантаження

• GET /api/v1/marketplace/stock/import/{import_id}/status — Отримати статус вивантаження залишків
• GET /api/v1/marketplace/drugstore/import/{import_id}/status — Отримати статус вивантаження аптек
• GET /api/v1/marketplace/goods/import/{import_id}/status — Отримати статус вивантаження товарів
• GET /api/v1/marketplace/users/import/{import_id}/status — Отримати статус вивантаження фармацевтів
• GET /api/v1/marketplace/users/import/{import_id}/status — Отримати статус вивантаження лікарів

Робота з замовленнями

• GET /api/v1/marketplace/order — Отримання всіх необроблених замовлень
• GET /api/v1/marketplace/drugstore/{drugstore_id}/order — Отримання всіх необроблених замовлень в аптеці
• GET /api/v1/marketplace/order/all — Отримання всіх оброблених замовлень за період
• GET /api/v1/marketplace/order/by-number/{order_number} — Отримання замовлення за номером
• GET /api/v1/marketplace/order— Оновлення замовлень

Вивантаження даних (рух товару)

• POST /api/v1/marketplace/data-import — Завантаження пакета даних
• POST /api/v1/marketplace/data-import/{import_id}/delete — Видалення пакета даних
• GET /api/v1/marketplace/data-import/{import_id}/status — Отримання статусу пакета даних
• GET /api/v1/marketplace/data-import/dictionaries — Отримання словника

Програма лояльності

Чеки

• POST /api/v1/promotion/analyze-before-sell — Отримання чека з доступними акціями (без операцій списання і нарахування)
• POST /api/v1/promotion/analyze-after-sell — Отримання чека з доступними акціями (з операціями списання і нарахування)
• POST /api/v1/promotion/write-off-bonuses/confirmation-code — Запит на отримання коду підтвердження для списання бонусів

Карта лояльності

• POST /api/v1/promotion/customer — Оновлення (створення) карти клієнта
• GET /api/v1/promotion/customer/search/{phone} — Отримання карти клієнта
• GET /api/v1/promotion/customer/verification-code — Отримання коду верифікації для вказаного номера телефону через SMS або дзвінок

Відправка повідомлень в боти

• POST /api/promotion/send_message — Розсилка (відправка повідомлення в бот)

• POST /api/promotion/message_status — Передача статусу повідомлення

Ehealth рецепти (для аптечних мереж)

• GET /api/v1/marketplace/prescription/ehealth/{recipeNumber} — Отримання рецепту Ehealth

Для страхових компаній

Призначення: пошук товарів, замовлення, довідники, eHealth-сценарій.

Ehealth рецепти (для страхових компаній)

• GET /api/v2/insurance/e-health-recipe/{recipe_number} — Отримання списку товарів за ehealth рецептом
• POST /api/v2/insurance/order/get-drugstores-for-e-health-recipe-goods — Перевірка доступності товару з ehealth рецепту в аптеках
• POST /api/v2/insurance/order/store-e-health-recipe-pick-up-order — Створення замовлення за ehealth рецептом

Товари

• GET /api/v2/insurance/goods/typeahead — Пошук товарів за назвою
• GET /api/v1/insurance/goods/balance — Кількість та ціни товарів в аптеках
• GET /api/v2/insurance/goods/price-list — Кількість та ціни товарів
• GET /api/v2/insurance/goods/general-price-list — Загальний прайс лист
• GET /api/v2/insurance/goods/analogues — Аналоги товару

Замовлення

• POST /api/v2/insurance/order/store-pick-up-order — Створення замовлення
• GET /api/v2/insurance/order — Отримання замовлення
• DELETE /api/v2/insurance/order — Скасування замовлення

Довідники

• GET /api/v2/insurance/drugstores — Довідник аптек

• GET /api/v2/insurance/goods/list — Довідник товарів

• GET /api/insurance/brand_photo — Отримання зображення бренду аптеки

Отримання атрибутів адреси

• GET /api/v2/insurance/address?region={назва_регіону} — Отримання списку областей
• GET /api/v2/insurance/address?region_id={region_id}&district={district} — Отримання списку районів
• GET /api/v2/insurance//address?region_id={region_id}&district_id={district_id}&city={city} — Отримання списку населених пунктів
• GET /api/v2/insurance/address?region_id={region_id}&district_id={district_id}&city_id={city_id}&street={street} — Отримання списку вулиць
• GET /api/v2/insurance/address?street_id={street_id} — Отримання списку будинків та поштових індексів

Звіти

• GET /api/v2/insurance/bill — Рахунок

Для онлайн-бронювання

Призначення: eHealth — товари → наявність → замовлення.

Ehealth рецепти (онлайн-бронювання)

• GET /api/v1/online-drugstore/e-health-recipe/{recipe_number} — Отримання списку товарів за ehealth рецептом
• GET /api/v1/online-drugstore/order/get-drugstores-for-e-health-recipe-goods — Перевірка доступності товару з ehealth рецепту в аптеках
• POST /api/v1/online-drugstore/order/store-e-health-recipe-pick-up-order — Створення замовлення за ehealth рецептом

Для Компаній

Призначення: товари, залишки, замовлення, звітність за ЄДРПОУ.

Отримання даних про товари та залишки

• GET /api/v1/company/goods — Отримання списку товарів
• GET /api/v1/company/stock — Отримання інформації про залишки товарів

Робота із замовленнями

• GET /api/v1/company/orders — Отримання списку замовлень
• POST /api/v1/company/order — Оновлення інформації про замовлення
• GET /api/v1/company/orders-sell-info — Отримання додаткової інформації проданих замовлень

Звітність та аналітика

• GET /api/v1/company/data/build — Отримання даних про купівлі
• GET /api/v1/company/data/result — Отримання результатів збірки даних

Моніторинг статусу сервісів

• GET https://status.pharmapoint.ua/index.json — Отримання статусу сервісів Pharmapoint (Better Stack Status Page API)

інформація

Наведено список методів API з коротким описом. Детальні описи ви зможете знайти, перейшовши на сторінку з документацією за конкретним методом API

Postman колекція

Програма лояльності
Для аптечних мереж
Для страхових компаній
Ehealth рецепти (онлайн-бронювання)
Для Компаній