Fuentes
Una fuente representa una fuente de datos de un servicio. Por ejemplo, una cuenta de iCloud es una fuente del servicio de iCloud.
Las fuentes pueden tener fuentes secundarias, como una fuente rirelay.instance
que tiene múltiples fuentes rirelay.source
que pueden ser dirigidas individualmente.
Atributos
nombre | tipo | descripción |
---|---|---|
id | ID de fuente | Identificador de recursos. |
resource | cadena, siempre source | Especificador de tipo de recurso. |
user | ID de usuario | El usuario asociado a esta fuente. |
type | cuerda | El tipo de esta fuente, por ejemplo icloud.account . |
identifier | cuerda | Un identificador único para la fuente dentro del alcance de su servicio. |
parent | opcional, ID de fuente | Se rellena si la fuente es hija de otro. |
children | objeto de lista que contiene recursos de origen | Contiene cualquier fuente secundaria de la fuente. |
state | cuerda | Uno de: no unvalidated , active , deactivated , blocked , locked . |
date_created | fecha y hora | Cuando el recurso fue creado. |
Tipos
Los tipos admitidos actualmente incluyen:
-
icloud.account
, la fuente principal en el servicio de iCloud. -
rirelay.instance
, la fuente primaria en el servicio rirelay. Corresponde a una instancia de la aplicación Reincubate Relay. -
rirelay.source
, una fuente secundaria derirelay.instance
. Corresponde a un dispositivo al que la aplicación Reincubate Relay principal tiene acceso.
Identificador
El valor de de una fuente de identifier
atributo lo identifica de forma única dentro de su servicio. Para una cuenta de iCloud, este sería el nombre de usuario. Para una instancia de la aplicación Reincubate Relay, sería la ID de la instancia.
Padre
Si la fuente es una fuente secundaria, este campo apuntará a su objeto fuente principal. La fuente superior en esta jerarquía se conoce como la fuente primaria.
Una fuente secundaria no se puede crear directamente a través de la API, pero la API la crea automáticamente cuando se crea la encuesta adecuada.
Estados
unvalidated
- una sesión nunca se ha creado correctamente contra esta fuente, por lo tanto, la API no puede saber si es una fuente válida.
active
- La fuente ha sido validada y está lista para su uso.
deactivated
- el acceso a la fuente ha sido prohibido por la organización propietaria.
blocked
- el acceso a la fuente ha sido prohibido por un administrador de API.
locked
- El acceso a la fuente ha sido restringido temporalmente por el servicio externo.
Recuperar GET /sources/{source ID}
Usando cURL
curl https://ricloud-api.reincubate.com/sources/<source ID> \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud source = ricloud.Source.create(<source ID>)
Respuesta de muestra
{ "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" }
Lista GET /sources
nombre | tipo | descripción |
---|---|---|
organisation | super, ID de organización | Para los administradores de API para filtrar por organización. |
user | ID de usuario | Filtrar por usuario asociado. |
type | cuerda | Filtrar por tipo de fuente. |
identifier | cuerda | Filtrar por identificador de fuente. |
state | cuerda | Filtrar por estado fuente. |
date_created | filtro de fecha y hora | Filtrar por fecha de creación del recurso. |
Usando cURL
curl https://ricloud-api.reincubate.com/sources \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud sources = ricloud.Source.list()
Actualizar POST /sources/{source ID}
nombre | tipo | descripción |
---|---|---|
state | cuerda | Actualiza el estado de origen. |
Usando 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" }'
Utilizando 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')
Registro de cambios
2020-02-20
- El Mayor
children
atributo del objeto de origen es ahora un objeto de lista anidada, en lugar de un simple atributo de lista.
2019-10-16
- Agrega dos nuevos tipos de fuente:
rirelay.instance
yrirelay.source
.