API (application programming interface) - це набір функцій та процедур, що забезпечують зв'язок між DocDream та сторонніми програмами. Таким чином, сторонні програми не мають прямого доступу до бази даних DocDream. Натомість вони передають запити на потрібну інформацію в API у заздалегідь обумовленому форматі. API перетворює це на запити, зрозумілі для DocDream, та передає їх у програму. DocDream обробляє запити та повертає в API набір потрібних даних. А далі API передає їх у сторонню програму, що надсилала початковий запит. Також через API можна передавати команди на виконання якихось дій (створення пацієнта, запис на прийом, надіслати пацієнту повідомлення тощо).
Таким чином, розробникам сторонніх програм для інтеграції з DocDream не потрібно розбиратися у складній моделі даних та в особливостях функціонування окремих модулів DocDream. Їм потрібно освоїти примітивні інструкції для обміну інформацією через API.
Зазвичай API використовують для інтеграції з мобільними додатками, зовнішніми сайтами, спеціальним обладнанням тощо.
Звичайно, доступ до API відкритий не всьому світу, а лише для зовнішніх запитів, що надходять із заздалегідь визначених IP-адрес та використовують наданий клінікою ключ доступу.
Інформація, що описується нижче, призначена для технічних спеціалістів, які хочуть інтегруватися з DocDream через API.
Ви можете протестувати роботу через API з демонстраційною версією DocDream. Опис методів знаходиться за адресою: https://demo.docdream.com:8001/swagger/index.html, ніяких обмежень по підключенню до демо-версії немає.
Бот Деде може розказати про деякі методи API докладніше, з прикладами та скріншотами. Розповідь починається тут.