протоколы

обновленный

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

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

Ряд стандартных взаимодействий с ресурсами может вызвать асинхронные «побочные эффекты», которые описаны в справочной документации API. Обычно они предназначены для проверки достоверности или других служебных функций.

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

Жду ответа

API поддерживает ожидание завершения асинхронных задач через долгоживущие запросы, чтобы минимизировать потребность в опросе и сократить общее время ответа для конечных пользователей. Чтобы включить эту функцию, добавьте HTTP-заголовок Ricloud-Await к вашим запросам с желаемым значением времени ожидания. Текущее максимальное время ожидания составляет 10 секунд.

Ricloud-Await: 3

Эта функциональность поддерживается на следующих конечных точках:

Зашифрованная публикация

Все результаты, опубликованные API, могут быть зашифрованы с использованием общеорганизационного открытого ключа RSA.

Типы атрибутов

Любые атрибуты даты и времени всегда будут отформатированы в соответствии со спецификацией ISO8601. API возвращает все атрибуты даты и времени с часовым поясом UTC. Следовательно, ожидаемый формат: "2018-08-22T10:25:05Z" .

пагинация

API использует пагинацию на основе курсора. Все вызовы типа списка принимают дополнительные параметры:

  • limit чтобы указать максимальное количество элементов, которые будут возвращены. Значение по умолчанию 10, максимальное значение 1000.
  • after_id для указания идентификатора, с которого начинается листинг.
  • before_id для указания идентификатора ресурса, с которого нужно остановить листинг.

Список ответов включает в себя возвращенные ресурсы под атрибутом data . Также включен вспомогательный атрибут has_more который указывает, можно ли перечислить больше ресурсов, которые не были включены из-за ограничения.

Ограничения скорости

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

Пример ограничения скорости: количество запросов к API от одной организации ограничено 10 000 запросов в час. Это помогает защитить от злонамеренных или случайных всплесков трафика.

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

Versioning

Хотя основные релизы API следует в основном семантической схеме управления версий (т.е. v1, v2, v3), любые изменения , сделанные в версии v3 в API являются версированными следующими схемами календаря управления версиями (т.е. 2018-11-06). Версия может быть установлена глобально для вашей организации или указана для каждого запроса через заголовок Ricloud-Version .

Удаляемые ресурсы

Большинство ресурсов не удаляются, то есть они могут быть деактивированы только организацией-владельцем или заблокированы администратором API.

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

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

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

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

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

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