Лучшие практики (v2)

обновленный

генеральный

Существует ряд лучших практик, позволяющих максимально эффективно использовать API-интерфейс Reincubate Cloud Data.

  • Используйте эту документацию. В этих материалах даны ответы на многие распространенные вопросы, и документация регулярно обновляется.
  • Страницу состояния API можно использовать для подписки на обновления любого запланированного или экстренного обслуживания API.
  • Клиенты, которые используют интеграционный канал Slack, как правило, начинают работать быстрее.
  • Клиент с открытым исходным кодом предоставляет полный пример интеграции со службой ricloud , и изучение этого (или повторное использование кода из него) может сэкономить много работы во время интеграции.
  • Используйте тестовые данные при тестировании и интеграции, но имейте в виду, что реальный доступ к данным может быть медленнее.
  • Следуйте рекомендациям по безопасности и конфиденциальности и не храните учетные данные конечного пользователя. Вместо этого используйте систему токенизации .
  • Не следует жестко кодировать отправку задачи или конечные точки результатов в запросах: хотя они часто могут принимать одно и то же значение, API может время от времени изменять их.
  • Не создавайте больше задач, чем необходимо: например, опрос обновлений резервной копии не требуется больше, чем несколько раз в день, и многое можно сделать, чтобы разработать для этого точный график. API способен выполнять большое количество задач и генерировать много данных за небольшое время, и, в частности, при использовании aschannel клиенты должны с осторожностью запрашивать больше, чем они могут с готовностью потреблять.
  • Reincubate считает, что рекомендуется напрямую связываться с владельцами аккаунтов в такие моменты, когда к их аккаунтам сначала обращаются, а затем на постоянной основе, чтобы убедиться, что они информированы об активности клиентов. Смотрите повышение конфиденциальности для более подробной информации.
  • Клиенты с требованиями регулярно опрашивать учетные записи должны оценивать как master, а не asapi .

🚨 Поддержка и статус обслуживания

Уведомления о статусе и обслуживании

Reincubate поддерживает страницу статуса на status.reincubate.com . Страницы статуса позволяют пользователям подписываться на обновления. Обновления отправляются для любого планового или аварийного обслуживания.

Прямая поддержка

Поддержка клиентов доступна по электронной почте ent-support@reincubate.com и по частным каналам интеграции Slack. Клиенты могут связаться со службой поддержки, чтобы договориться о настройке канала интеграции.

Сообщения о проблемах

При возникновении проблем с API-интерфейсом он может ускорить разрешение, если группа поддержки будет информирована о HTTP-заголовке X-RI-Build полученном в ответе на проблему. HTTP-заголовок X-RI-Build выглядит следующим образом:

X-RI-Build: 1.0-pre-ios9-395-g126226b; nj-api-7

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

🔓 Минимизация блокировки учетной записи iCloud

Apple блокирует учетные записи iCloud с различными частотами на основе большого и динамического набора критериев. В целом, они делятся на три категории:

  1. То, как технология соединяется
  2. Природа инфраструктуры, используемой для общения
  3. Ритм, паттерны и частота, с которой эта технология связывается

API облачных данных Reincubate обращается ко всем трем по мере их развития. Первый обрабатывается закрытым кодом API, а второй - существенным и сложным инфраструктурным стеком, который поддерживает Reincubate. Однако при непосредственном управлении API с помощью asapi клиенты могут столкнуться с трудностями при управлении # 3 в масштабе или в случаях использования, которые требуют регулярного опроса.

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

🎁 Макет данных для интеграции и тестирования

Пример данных службы Apple iCloud

john.appleseed@reincubate.com учетная запись данных службы Apple iCloud предоставляется под john.appleseed@reincubate.com записью john.appleseed@reincubate.com , которая доступна с паролем joshua . Данные предоставляются для быстрого тестирования интеграции с API.

Доступ к этой учетной записи не оплачивается, и данные образца доставляются непосредственно с серверов Reincubate, что значительно ускоряет время отклика.

Часто задаваемые вопросы

Хранит ли API какой-либо фид или данные файла?

Нет, не при использовании с aschannel , поскольку данные фида и файла передаются клиентам и не сохраняются в стеке RI. При использовании asstore информация сохраняется в контейнерах до тех пор, пока не будет получена. Тем не менее, канал рекомендуется для почти всех случаев использования.

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

Как запросить каналы и вложения с asmaster ?

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

Как мне сказать asmaster дать мне больше или меньше модулей?

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

С какой частотой опрашивает асмастер ?

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

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

Набор правил для выбора частоты является динамическим.

Какие ограничения установлены для пробного ключа?

Ограничения пробного ключа могут различаться в зависимости от характера ключа. Они могут быть ограничены:

  • Количество устройств или учетных записей, доступных через ключ
  • Поддержка учетных записей не-2FA / 2SV (например, пробные пользователи могут быть лишены доступа к учетным записям не-2FA по соображениям соответствия)

Где находится API?

Смотрите примечание в разделе хостинг и подключение .

Почему я не вижу данных для типа данных xyz?

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

  1. Убедитесь, что соответствующий параметр для типа данных включен.

    • Для типов данных, источником которых является резервная копия устройства iOS, это означает включение резервного копирования iCloud в Settings > [user name] > iCloud > iCloud Backup > iCloud Backup и обеспечение Settings > [user name] > iCloud > iCloud Backup > iCloud Backup устройства хотя бы один раз. Резервное копирование можно запустить вручную, нажав кнопку « Back Up Now на вышеупомянутом экране.
    • Для типов данных в режиме реального времени и в ближайшем времени параметры, как правило, более специфичны для службы, отвечающей за синхронизацию данных с iCloud. Например, настройку, связанную с «Найти мой iPhone», можно найти в разделе « Settings > [user name] > iCloud > Find My iPhone > Find My iPhone . Соответствующий параметр указан вместе с другими свойствами типов данных в разделе модулей подачи .
  2. Убедитесь, что устройство получает возможность синхронизировать данные.

    • Для каналов на основе резервного копирования iCloud устройство необходимо подключить и заблокировать, чтобы начать автоматическое резервное копирование iCloud. Вы все еще можете запустить резервное копирование вручную в любое время.
    • Для типов данных в реальном времени и в режиме реального времени триггеры синхронизации различаются в зависимости от структуры службы. Как правило, для запуска некоторых более медленных процессов синхронизации может потребоваться около 4-6 часов.

неодобрение

  • Начиная с первого квартала 2017 года устаревшую версию ricloud 1.x можно считать устаревшей, хотя она все еще полностью поддерживается благодаря адаптеру, который преобразует и направляет трафик в asapi .

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

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

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

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

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

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