источники
Источник представляет собой источник данных из службы. Например, учетная запись iCloud является источником службы iCloud.
Источники могут иметь дочерние источники, такие как источник rirelay.instance
имеющий несколько источников rirelay.source
которые могут быть нацелены индивидуально.
Атрибуты
название | тип | описание |
---|---|---|
id | идентификатор источника | Идентификатор ресурса. |
resource | строка, всегда source | Спецификатор типа ресурса. |
user | Идентификатор пользователя | Пользователь, связанный с этим источником. |
type | строка | Тип этого источника, например, icloud.account . |
identifier | строка | Уникальный идентификатор источника в пределах его службы. |
parent | необязательно, идентификатор источника | Заполняется, если источник является дочерним от другого. |
children | список объектов, содержащих исходные ресурсы | Содержит любые подисточники источника. |
state | строка | Один из: не unvalidated , active , deactivated , blocked , locked . |
date_created | Дата и время | Когда ресурс был создан. |
Типы
В настоящее время поддерживаются следующие типы:
-
icloud.account
, первоисточник службы iCloud. -
rirelay.instance
, первоисточник службы rirelay. Соответствует экземпляру приложения Reincubate Relay. -
rirelay.source
, дочерний источникrirelay.instance
. Соответствует устройству, к которому имеет доступ родительское приложение Reincubate Relay.
Идентификатор
Значение атрибута идентификатора источника identifier
его уникально в пределах его службы. Для учетной записи iCloud это будет имя пользователя. Для экземпляра приложения Reincubate Relay это будет идентификатор экземпляра.
родитель
Если источник является дочерним источником, это поле будет указывать на его родительский исходный объект. Верхний источник в этой иерархии называется основным источником.
Дочерний источник не может быть создан напрямую через API, но автоматически создается API при создании соответствующего опроса.
состояния
unvalidated
- сеанс никогда не был успешно создан для этого источника, поэтому API не может определить, является ли он допустимым источником.
active
- источник был проверен и готов к использованию.
deactivated
- доступ к источнику был запрещен организацией-владельцем.
blocked
- доступ к источнику был запрещен администратором API.
locked
- доступ к источнику был временно ограничен внешней службой.
Получить GET /sources/{source ID}
Использование cURL
curl https://ricloud-api.reincubate.com/sources/<source ID> \ -H 'Authorization: Token <your key_token>'
Использование ricloud-py
import ricloud source = ricloud.Source.create(<source ID>)
Образец ответа
{ "id": 1, "resource": "source", "user": 1, "type": "mocks.mock", "identifier": "john.appleseed@reincubate.com", "info": null, "parent": null, "children": { "data": [], "has_more": false, "total_count": 0, "url": "/sources/1/children" }, "state": "active", "date_created": "2020-02-20T11:59:03.195527Z" }
Список GET /sources
название | тип | описание |
---|---|---|
organisation | супер, идентификатор организации | Для администраторов API для фильтрации по организации. |
user | Идентификатор пользователя | Фильтровать по связанному пользователю. |
type | строка | Фильтр по типу источника. |
identifier | строка | Фильтр по идентификатору источника. |
state | строка | Фильтр по состоянию источника. |
date_created | фильтр даты и времени | Фильтр по дате создания ресурса. |
Использование cURL
curl https://ricloud-api.reincubate.com/sources \ -H 'Authorization: Token <your key_token>'
Использование ricloud-py
import ricloud sources = ricloud.Source.list()
Обновить POST /sources/{source ID}
имя | тип | описание |
---|---|---|
state | строка | Обновите исходное состояние. |
Использование cURL
curl https://ricloud-api.reincubate.com/sources/<source ID> \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "state": "deactivated" }'
Использование ricloud-py
import ricloud source = ricloud.Source.update_with_id(<source ID>, state='deactivated') # OR source = ricloud.Source.retrieve(<source ID>) source.update(state='deactivated')
Изменения
2020-02-20
- Major Атрибут
children
исходного объекта теперь является вложенным списком, а не простым списком.
2019-10-16
- Добавляет два новых типа источников:
rirelay.instance
иrirelay.source
.