Обзор (v2)

обновленный

Вступление

Есть четыре вида услуг , которые включают и используются для взаимодействия с ricloud API: asmaster, asapi, aschannel и asstore. Клиенты обычно взаимодействуют только с двумя из этих служб, а не со всеми четырьмя.

API можно контролировать одним из двух способов: с помощью asmaster или asapi . Результаты получены из aschannel (поток пожарных шлангов для поиска данных в реальном времени) или из хранилища ( контейнер для пакетного поиска данных).

Составная часть Результаты доставки Лучше всего подходит для Управление токенами
asmaster aschannel Регулярный поиск данных Reincubate
asapi канал или магазин Редкий доступ с небольшим объемом Отложено на клиента

Доступ к данным в режиме реального времени

С помощью asmaster клиенты регистрируют учетные записи или устройства, а затем получают новые данные в потоке в режиме реального времени, когда они становятся доступными. По сути, asmaster - это интеллектуальный контроллер для asapi , который еще больше снижает потребность клиента в понимании механизма хранения и извлечения данных, и который может предоставлять данные быстрее и безопаснее, чем клиент, используя собственную реализацию против asapi .

В зависимости от базового типа данных и источника asmaster либо подписывается внутренне на восходящий поток данных для обновлений в реальном времени, либо использует интеллектуальный прогностический планировщик для управления опросом.

Ближайшее время и пакетный доступ к данным

С помощью asapi клиенты запрашивают данные из учетных записей или устройств, как и когда они этого хотят, а затем получают данные, когда они готовы в потоке или путем опроса корзины .

Концепции и услуги

API ricloud моделируется вокруг четырех ключевых понятий: действия , задачи , услуги и учетные записи .

Действия являются основной единицей работы, выполняемой API; Каждое действие связано с услугой . Например, один может выполнить fetch_data действие, часть icloud службы. Каждое действие выполняется против учетной записи . Учетные записи представляют собой учетные записи конечных пользователей, из которых извлекаются данные службы . Учетная запись доступна для клиента, если она была зарегистрирована этим клиентом. Каждый экземпляр действия описывается как задача , и ему присваивается task_id .

Мастер потоков приложений ( asmaster )

asmaster - это механизм контроля подписки для API. Это позволяет пользователям:

  • Узнайте об услугах , действиях и конечных точках, которые им разрешено использовать
  • Зарегистрируйтесь, отмените регистрацию и узнайте об аккаунтах
  • Подписаться и отписаться на автоматическую подачу данных из аккаунтов

При таком подходе asmaster автоматически генерирует задачи для asapi , а полученные данные получают из aschannel .

Подробная документация для asmaster доступна при подписке на данные с asmaster .

API потока приложений ( asapi )

asapi - это асинхронный механизм управления API. Это позволяет пользователям:

  • Узнайте об услугах , действиях и конечных точках, которые им разрешено использовать
  • Зарегистрируйтесь, отмените регистрацию и узнайте об аккаунтах
  • Отправить асинхронные задачи
  • Запрос статуса задач

После завершения данные из задач могут быть получены либо из канала, либо из хранилища , в зависимости от варианта использования клиента.

Подробная документация для asapi доступна при запросе данных у asapi .

Канал потокового приложения ( aschannel )

aschannel является конечной точкой потоковой передачи, которая позволяет клиентам получать результаты каждой переданной задачи в режиме реального времени по мере их создания.

Результаты можно получить, открыв соединение с конечной точкой канала .

  • Результаты передаются в формате JSON
  • Как только они становятся доступными, их можно получить из службы
  • Канал не имеет статуса; если клиент пропускает передачу результата, он не может быть воспроизведен без повторной отправки задачи

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

Хранение потоков приложений (в магазине )

Asstore - это ограниченное по времени хранилище результатов, которое позволяет клиентам получать результаты отправленных задач по мере их появления.

  • Результаты сохраняются в течение ограниченного периода времени до истечения срока их действия и удаления
  • Результат может быть загружен только один раз; он удаляется после использования

Подробная документация для магазина доступна при загрузке данных с магазина .

Используемые стандарты

В Ricloud и его документации используются следующие стандарты:

  • API последовательно использует даты в формате ISO-8601 в часовом поясе UTC . Например, 24 декабря будет выражаться как 2014-12-24 17:30:00.000000 .
  • Структурированные данные, возвращаемые компонентами ricloud , всегда используют JSON . Это неизменно указывается типом содержимого application/json в ответах.
  • Примеры команд в этой документации приведены в формате bash с использованием команды curl .

Как мы можем помочь?

Наша служба поддержки здесь, чтобы помочь!

Наш офис работает с понедельника по пятницу с 9:00 до 17:00 по Гринвичу. Время в настоящее время 3:39 ПП с GMT.

Мы стремимся отвечать на все сообщения в течение одного рабочего дня.

Перейти в раздел поддержки › Связаться с командой предприятия ›
Наша отличная команда поддержки

© 2008 - 2019 Reincubate Ltd. Все права защищены. Зарегистрировано в Англии и Уэльсе #5189175, VAT GB151788978. Reincubate® является зарегистрированным товарным знаком. Защита & Условия. Мы рекомендуем 2FA. Построен с в Лондоне.