Руководство разработчика VMS
Раздел «Руководство разработчика» предоставляет подробную информацию об API VMS, предназначенном для интеграции и взаимодействия с системой VMS. В этом разделе описаны основные принципы работы API, доступные методы, а также примеры их использования. Подробные схемы запросов и ответов помогут разработчикам быстро освоить работу с API и эффективно использовать его возможности.
Обзор содержания раздела
На следующих страницах вы найдете подробную информацию о том, как использовать API VMS.
Версионность продукта
Этот раздел объясняет, как и когда выпускаются новые версии продукта.
Принципы работы с API VMS
Аутентификация и доступ к API – объяснение способов аутентификации, используемых API.
Используемые заголовки в запросах.
Настройка языка – информация о настройке языка получаемых данных через API VMS.
Валидация. Статусы обработки запроса: подробное описание HTTP-кодов и их значений для обозначения успешного ответа на запрос или запроса с ошибкой.
Пагинация – руководство по работе с пагинированными ответами.
Методы API
В данном разделе представлены методы API, используемые для взаимодействия с системой VMS. Для удобства использования методы API сгруппированы по тематическим блокам. Каждый блок включает вводную информацию, а последующие страницы для навигации организованы в алфавитном порядке. Внутри каждого раздела запросы упорядочены в соответствии с HTTP-методами: POST, GET, PUT, PATCH, DELETE.
Документация блоков «API для интеграции» и «VMSMobileSDK» находится в открытом доступе.
Другие разделы API-документации предоставляются по запросу.
Содержание блоков:
API для интеграции: Запросы и ответы, относящиеся к обеспечению эффективной интеграции платформы управления видеонаблюдением (VMS) с внешними системами, включая биллинговые платформы, CRM и системы провижининга операторов связи.
VMSMobileSDK: Содержит методы, специфичные для мобильного приложения.
VMS Admin: Запросы и ответы, связанные с администрированием системы, управлением пользователями и настройками. Документация предоставляется по запросу.
VMS Client: Запросы и ответы, используемые клиентскими приложениями для получения данных и выполнения операций. Документация предоставляется по запросу.