intro - TotalApi/SDK-dNet GitHub Wiki

Введение

TotalAPI - представляет собой облачную службу предоставляющую различные API для разработки программных комплексов, а также SDK который позволит легко использовать эти API. TotalAPI задумывался как удобный фреймворк для разработки SaaS приложений, которые управляют информацией о состоянии различных объектов и их местоположении в пространстве. Например, спутниковый мониторинг транспорта и условий транспортировки грузов, удаленное обслуживание «Умных домов» и мониторинг пользовательских и промышленных сенсорных сетей (IoT), и многие другие. Наша облачная служба спроектирована так чтобы гарантировать бесперебойную и быструю (5000 и более записей в секунду) запись и чтение данных, а также обеспечивать легкое масштабирование. TotalAPI также включает инструменты для гибкой настройки тарифных планов, выделение отдельного пула серверов и хранилищ для индивидуального использования ресурсов и многое другое.

Основные функции API

Инфраструктура приложения

  • Гибкая аутентификация приложения с использованием секретного ApiKey или публичного AppKey
  • Работа с неограниченным количеством пользователей вашего приложения (регистрация/редактирование/удаление).
  • Разграничение доступа пользователей к данным.
  • Возможность прозрачной отправки/получения уведомлений между всеми частями программного комплекса.
  • Возможность расширять стандартный API дополнительными распределёнными модулями в том числе и собственными.

Телеметрия

Набор API, реализующий работу с датчиками мы назвали metriX™.

  • Быстрая запись значений от различных датчиков. В минимальной конфигурации запись данных с более чем 5000 датчиков в секунду
  • Работа с неограниченным количеством устройств слежения и датчиков (регистрация/редактирование/удаление).
  • Запись и ведение истории местоположения (координаты, скорость, высота, направление) и значений датчиков с каждого устройства слежения.
  • Быстрое получение информации о последнем местоположении устройства слежения или значении конкретного датчика.
  • Выдача трека/отчета (набора точек местоположения) за указанный период с возможностью наложения дополнительных фильтров (фильтр остановок/разрывов/скорости/упрощения).

Состав API

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

  • metriX API Набор интерфейсов API, реализующих функции получения и обработки данных с датчиков, объединен в группу Telematics API.
  • Repository API Универсальное API для доступа к различным бизнес-объектам. Например, Repository API используется для управления списками датчиков, устройств слежения или реестром пользователей. Repository API предоставляет набор CRUD интерфейсов для различных типов объектов.
  • Events API Универсальное API для получения различных событий. Например, изменения свойств объекта в реестре пользователей, факт получения нового значения сенсора или уведомление об окончании работы асинхронной задачи. Клиент должен подписаться на конкретный тип событий чтобы получать уведомления.
  • Billing API В группу Billing включены интерфейсы API, которые управляют безопасностью системы (регистрация клиентских приложений, аутентификация клиентов, установка пароля…) и предоставляют информацию о текущем тарифном плане клиента и состоянии его счета.

Использование TotalAPI SDK

Для того чтобы упростить работу с методами API разработан специальный TotalAPI SDK. Мы рекомендуем использовать этот SDK! На данный момент реализована .NET версия. Наш SDK представляет собой высокоуровневую обёртку над методами API, но что более важно, в SDK уже реализованы многие инфраструктурные алгоритмы работы с API - такие как механизмы авторизации, работа с распределёнными частями сервиса и обмена сообщениями между ними, работы с асинхронными методами сервиса и многое другое.

⚠️ **GitHub.com Fallback** ⚠️