API ключове и webhooks

Започнете безопасно в тестовата среда

Тестовият ключ работи само в /api/sandbox/v1. Не изпраща имейл или SMS и не създава таксуване. Не качвайте реални медицински данни в тестовата среда.

1. 1От „Разработчици“ изберете „Започни в тестовата среда“ и създайте отделен тестов ключ.
2. 2Изпълнете синтетичен сценарий. При промяна на сценария се създава нова операция; повторният опит на същия сценарий запазва референцията. HTTP резултатът, лимитът и референцията са показани под формата.
3. 3Добавете свой HTTPS webhook с включено webhook.test, изпратете подписан тест и проверете подписа с показаната веднъж тайна. В „Заявки и доставки“ проверете действителния отговор и разрешения повторен опит. Едва след това създайте отделен ограничен ключ за реалната клиника.

API ключ

1. 1Дайте описателно име.
2. 2Изберете само нужните scopes.
3. 3Задайте разумен срок — по подразбиране 90 дни.
4. 4Копирайте тайната веднага — тя не може да се покаже отново.
5. 5За създаване на предаване, получател или заявка изпращайте Idempotency-Key. Повторение със същото тяло връща същия резултат, а различно тяло се отказва. Качването на файл не е идемпотентно.
6. 6Оттеглете ключа при съмнение или когато интеграцията приключи.

Webhook подпис

Проверете HMAC-SHA256 върху timestamp + точка + MediSend-Delivery + точка + суровото тяло. Приемайте timestamp само в рамките на 5 минути. Записвайте атомично payload.id, за да не изпълните едно събитие повторно; MediSend-Delivery е идентификаторът на конкретната доставка. Подписът се проверява преди обработката. Payload-ът не съдържа клиничен текст или произволни audit metadata.

Проверка след прекъснато API качване

При неясен резултат от multipart качване проверете GET /api/v1/handovers/{id} с handovers:read преди нов опит. data.files съдържа идентификатор, SHA-256, размер, състояние на проверката и час само за файлове, качени от интеграцията. Сравнете размера и контролната сума с изпратения файл. Няма имена, медицинско съдържание, DICOM данни или адреси за изтегляне. Записан файл не означава успешно сканиран файл или изпратено предаване; при неясно съответствие прегледайте черновата в MediSend.

• API документация и примери

Смяна на тайна

След смяна всяка доставка има v1 подпис с новата тайна и v0 подпис със старата за 24 часа. Обновете приемащата система в този прозорец; след него старата тайна не подписва доставки.

Грешки

MediSend пази броя опити, HTTP статуса и безопасна категория на грешката. След трайни последователни грешки endpoint-ът се изключва автоматично.