Сервисный ключ API

Сервисный ключ API

Функционал, который дает возможность сторонним сервисам создать более удобную для пользователей интеграцию с Ветменеджер.

Преимущества перед обычными API ключами:

  • Единый ключ ко всем клиникам.
  • Не нужно просить API ключ у пользователя. Пользователь включает сервис в настройках Ветменеджер.
  • Список методов фиксируется при выдаче ключа. Клиника этот список не меняет. 
  • Запрос к методу вне списка отвечает кодом 401.

Авторизация в API

Два заголовка, одни и те же для всех клиник: X-SERVICE-NAME и X-SERVICE-REST-API-KEY.

curl -X GET \
https://домен.vetmanager.ru/rest/api/clinics \
-H 'X-SERVICE-NAME: имя-сервиса' \
-H 'X-SERVICE-REST-API-KEY: сервисный-ключ'

Где: 

домен — уникальная часть адреса клиники.

имя-сервиса — имя сервиса, выданное Ветменеджер.

сервисный-ключ — ключ, полученный у Ветменеджер.

Как получить сервисный ключ

Свяжитесь с поддержкой Ветменеджер и передайте:

  • имя и описание сервиса;
  • нужные адреса и действия для них (GET, POST, PUT, DELETE);
  • телефон или Telegram.

Поддержка выдает имя сервиса и сервисный ключ.

Какие клиники включили сервис

Для этого есть отдельный адрес и отдельный секрет. Секрет выдает поддержка, он есть не у каждого сервисного ключа.

GET https://billing-api.vetmanager.cloud/external-services/имя-сервиса/enabled-domains?secret=секрет

Список кешируется на 24 часа. Первый запрос после обновления кеша идет по всем клиникам и может выполняться до 5 минут, следующие проходят быстро. Клиника появляется в списке после обновления кеша, не сразу после включения.

Пример ответа:

{"error":false,"data":[{"domain":"test","url":"https://test.vetmanager.cloud"},{"domain":"test2","url":"https://test2.vetmanager2.ru"}]}

```

Powered by