обзор

обновленный

This is the documentation for Reincubate's ricloud API. The API provides users access to their own data in Apple's iCloud and local iTunes backups via the Reincubate Relay app.

For product information see the ricloud API product page.

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

Ресурсы

The API is organised into a set of resources. A client can create, retrieve, update and destroy (CRUD) these to configure, trigger, and monitor operations on the API. See the API resource reference for more details.

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

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

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

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

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

Notification of asynchronous operation completion is handled via webhooks, whereby events are sent to a client's server through standard HTTP requests. These events contain information on where to find requested data within a client's bucket, allowing the client to make a decision on when and how to use it.

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

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

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

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

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

Источник

These are specific sources of data within a service. An iCloud account is the primary source of the iCloud service, whereas a Reincubate Relay app instance is the primary source of the Reincubate Relay service.

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

A user represents the end-user that is requesting data. In many cases, this will be a user of your application.

сессия

A session represents access to a specific source, and one is needed in order to retrieve any information or data from the source through the API.

Creating a session is the equivalent of a 'login' into an iCloud account or 'pairing' with a Reincubate Relay app instance.

The API will execute the session initialisation process asynchronously. This means the call to create a session will return immediately, but the session will not be ready to use until initialisation has completed.

Опрос

Polls are how users can request data through the API. An active session against the targeted source is needed for a poll to be created.

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

задача

These are the underlying chunks of work performed by the API. When a session is created, it also creates a task in order to perform any initialisation against external services. When a poll is created, it will create at least one task to perform any necessary work.

Result

A result is a reference to data or a file published to a client's storage bucket.

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

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

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

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

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

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

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

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