обзор
Это документация для ricloud API Reincubate. API предоставляет пользователям доступ к их собственным данным в Apple iCloud и локальным резервным копиям iTunes через приложение Reincubate Relay.
Для получения информации о продукте см. Страницу продукта ricloud API .
Ключевые идеи
Ресурсы
API организован в набор ресурсов. Клиент может создавать, извлекать, обновлять и уничтожать (CRUD) их для настройки, запуска и мониторинга операций в API. См. Ссылку на ресурс API для более подробной информации.
Асинхронная обработка
API использует асинхронные операции для настройки сеансов с использованием сторонних сервисов и обработки данных. Это дает ему возможность управлять большим объемом спроса на данные при ответственном взаимодействии с внешними сервисами. Это также дает дополнительную гибкость, чтобы реагировать на колебания времени отклика или ухудшение качества услуг со стороны третьих лиц.
Публикация хранилища
Данные, запрашиваемые у API, публикуются непосредственно в корзину клиента в Google Cloud Storage или Amazon S3. Это помогает минимизировать проблемы, связанные с масштабированием доставки данных, а также обеспечивает более быстрый поиск данных, поскольку публикация с меньшей вероятностью станет узким местом.
Webhook уведомления
Уведомление о завершении асинхронной операции обрабатывается через веб-подключения, посредством которых события отправляются на сервер клиента с помощью стандартных HTTP-запросов. Эти события содержат информацию о том, где найти запрошенные данные в корзине клиента, что позволяет клиенту принять решение о том, когда и как его использовать.
Основные условия
Прежде чем погрузиться в раздел «Начало работы», полезно ознакомиться с несколькими терминами и понятиями, которые будут использоваться повсюду.
обслуживание
Служба описывает набор источников данных, доступных через API. Это включает сторонние сервисы, такие как iCloud, или продукты Reincubate, такие как asrelay .
Различные службы будут предъявлять различные требования к определенным ресурсам API, а также изменять общий жизненный цикл объектов API. Например, полезная нагрузка, необходимая для создания сеанса для службы iCloud, отличается от той, которая требуется для службы asrelay .
Источник
Это конкретные источники данных внутри службы. Учетная запись iCloud является основным источником службы iCloud, в то время как экземпляр приложения Reincubate Relay является основным источником службы Reincubate Relay.
пользователь
Пользователь представляет конечного пользователя, который запрашивает данные. Во многих случаях это будет пользователь вашего приложения.
сессия
Сеанс представляет доступ к определенному источнику, и он необходим для получения любой информации или данных из источника через API.
Создание сеанса эквивалентно «входу» в учетную запись iCloud или «сопряжению» с экземпляром приложения Reincubate Relay.
API выполнит процесс инициализации сеанса асинхронно. Это означает, что вызов для создания сеанса будет немедленно возвращен, но сеанс не будет готов к использованию до завершения инициализации.
Опрос
Опросы - это то, как пользователи могут запрашивать данные через API. Для создания опроса необходим активный сеанс с целевым источником.
Все опросы обрабатываются асинхронно с помощью одной или нескольких задач, и результаты публикуются в области облачного хранилища, настроенные в вашей организации.
задача
Это основные части работы, выполняемой API. Когда сеанс создается, он также создает задачу для выполнения любой инициализации с внешними службами. Когда опрос создан, он создаст хотя бы одну задачу для выполнения любой необходимой работы.
Результат
Результатом является ссылка на данные или файл, опубликованный в хранилище клиента.
