обзор

обновленный

Это документация для третьей версии ricloud API Reincubate . API предоставляет пользователям механизм легкого доступа к данным приложения из различных источников, включая Apple iCloud и локальное резервное копирование iTunes через asrelay .

Для получения информации о продукте см. Страницу продукта ricloud .

Основные условия

Прежде чем погрузиться в раздел «Начало работы», полезно ознакомиться с несколькими терминами и понятиями, которые будут использоваться повсюду.

обслуживание

Служба описывает набор источников данных, доступных через API. Это включает сторонние сервисы, такие как iCloud, или продукты Reincubate, такие как asrelay .

Различные службы будут предъявлять различные требования к определенным ресурсам API, а также изменять общий жизненный цикл объектов API. Например, полезная нагрузка, необходимая для создания сеанса для службы iCloud, отличается от той, которая требуется для службы asrelay .

Источник

Это конкретные источники данных внутри службы. Учетная запись iCloud является основным источником службы iCloud, тогда как экземпляр клиента asrelay является основным источником службы asrelay .

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

пользователь

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

сессия

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

Создание сеанса является эквивалентом «входа» в учетную запись iCloud или «сопряжения» с экземпляром клиента asrelay .

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

Опрос

Опросы - это то, как пользователи могут запрашивать данные через API. Активный сеанс с целевым источником необходим для настройки опроса.

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

задача

Это основные части работы, выполняемой API. Когда сеанс создается, он также создает задачу для выполнения любой инициализации с внешними службами. Когда опрос создается, он создает как минимум одну задачу для выполнения поиска данных.

Ключевые идеи

Ресурсы

API организован вокруг набора ресурсов, описанных в справочнике ресурсов API. Благодаря этим ресурсам клиент API может: настраивать свою конфигурацию API, инициализировать доступ к источнику данных и получать данные из этих источников.

Асинхронная обработка

API использует асинхронные операции для настройки сеансов с использованием сторонних сервисов и обработки данных. Это дает ему возможность управлять большим объемом спроса на данные при ответственном взаимодействии с внешними сервисами. Это также дает дополнительную гибкость, чтобы реагировать на колебания времени отклика или ухудшение качества услуг со стороны третьих лиц.

Публикация хранилища

Данные, запрашиваемые у API, публикуются непосредственно в корзину клиента в Google Cloud Storage или Amazon S3. Это помогает минимизировать проблемы, связанные с масштабированием доставки данных, а также обеспечивает более быстрый поиск данных, поскольку публикация с меньшей вероятностью станет узким местом.

Webhook уведомления

Уведомление о завершении асинхронной операции обрабатывается с помощью механизма webhook, посредством которого события отправляются на сервер клиента посредством стандартных HTTP-запросов. Эти события содержат информацию о том, где найти запрошенные данные в корзине клиента, что позволяет клиенту принять решение о том, когда и как его использовать.

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

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

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

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

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

Можем ли мы улучшить эту статью?

Нам нравится слышать от пользователей: почему бы не написать нам электронное письмо, оставить комментарий или написать в Твиттере @reincubate?

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