Центр поддержки разработчиков

Добро пожаловать! Данный документ поможет вам максимально полно раскрыть потенциал взаимодействия вашей IT-инфраструктуры с нашей облачной платформой.

Интерфейсы

На данный момент интерфейс взаимодействия состоит из двух API, отвечающих за разные сущности:

API управления

Позволяет повторить и расширить функционал NMD в части управления: аккаунтом, подключенными сервисами и их настройками.
Переход к документации

API статистики

Предоставляет подробную статистическую информацию по работе сервисов и отчеты.
Переход к документации

Аутентификация

API поддерживает 2 варианта аутентификации:

  • API-токен

    Для получения токена необходимо открыть клиентский кабинет Ngenix MultiDesk (NMD), перейти на вкладку "Мой профиль" и сгенерировать новый API-токен нажатием кнопки "Сгенерировать новый".

    После нажатия в интерфейсе будет отображаться новый токен и доступ к API будет возможен только через новый токен - ранее сгенерированный токен инвалидируется и более непригоден для аутентификации вызовов NGENIX API. Запишите полученный токен локально - в следующий раз посмотреть его не удастся и придется создавать токен повторно.

    Аутентификация вызовов выполняется путём передачи логина и токена по протоколу HTTPS в режиме HTTP basic access authentication.

    Пример аутентификации по токену

    В качестве примеров запроса в этом разделе и далее будет использоваться curl.

    curl -u <login>/token:<token> 'https://api.ngenix.net/...'

    где:

    • <login> — email используемый для входа в NGENIX MutiDesk
    • /token — команда на аутентификацию по токену
    • <token> — токен из NGENIX Multidesk
  • OpenID

    Метод используется в NMD и документации для разработчиков. Именно поэтому при выполнении запросов со страниц документации, пример запроса с помощью утилиты curl будет содержать заголовок Authorization: Bearer. Это сессионный ключ и на данный момент он может быть использован только в рамках наших приложений. В будущем мы сделаем данный метод аутентификации доступным также и для ваших приложений.