Перейти к основному содержимому

Общие сведения об API

HTTP API — программный интерфейс для подключения двухфакторной аутентификации на сайты и в приложения.

Принцип работы

API использует REST архитектуру, все запросы и ответы API передаются в кодировке UTF-8, в формате json с обязательным указанием заголовка

Content-Type: application/json

Для взаимодействия используются HTTP методы:

  • GET — для получения информации
  • POST — для создания сущности
  • PUT — для изменения сущности
  • DELETE — для удаления

Любой ответ системы включает в себя как минимум два параметра:
success и message.

{ "success": false, "message": "Something wrong" }

Базовый адрес API https://api.multifactor.kz

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

Для аутентификации запроса используется HTTP Basic Auth:

  • Логин и пароль разделяются двоеточием (login:pwd) и кодируются в base64 bG9naW46cHdk
  • Полученное значение передается в заголовке Authorization: Basic bG9naW46cHdk

Логином является Api Key, паролем Api Secret. Оба этих значения доступны в личном кабинете: раздел "Ресурсы" -> "Параметры".

Ping

Функция для проверки взаимодействия с системой.
Адрес https://api.multifactor.kz/ping | метод GET | параметры не требуются.

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

{"model":"Pong","success":true,"message":null}