Fontes
Uma fonte representa uma fonte de dados de um serviço. Por exemplo, uma conta do iCloud é uma fonte do serviço do iCloud.
As fontes podem ter fontes filho, como uma fonte rirelay.instance
com várias fontes rirelay.source
que podem ser segmentadas individualmente.
Atributos
nome | tipo | descrição |
---|---|---|
id | ID da fonte | Identificador de recursos. |
resource | string, sempre source | Especificador de tipo de recurso. |
user | ID do usuário | O usuário associado a essa fonte. |
type | corda | O tipo dessa fonte, por exemplo icloud.account . |
identifier | corda | Um identificador exclusivo para a fonte no escopo de seu serviço. |
parent | ID de origem opcional | Preenchido se a fonte for filha de outro. |
children | objeto de lista que contém recursos de origem | Contém quaisquer sub-fontes da fonte. |
state | corda | Um de: não unvalidated , active , deactivated , blocked , locked . |
date_created | data hora | Quando o recurso foi criado. |
Tipos
Os tipos atualmente suportados incluem:
-
icloud.account
, a principal fonte no serviço iCloud. -
rirelay.instance
, a principal fonte do serviço rirelay. Corresponde a uma instância do aplicativo Reincubate Relay. -
rirelay.source
, uma fonte filho derirelay.instance
. Corresponde a um dispositivo ao qual o aplicativo Reincubate Relay pai tem acesso.
Identificador
O valor de uma fonte identifier
atributo identifica exclusivamente dentro do seu serviço. Para uma conta do iCloud, esse seria o nome de usuário. Para uma instância de aplicativo Reincubate Relay, seria o ID da instância.
Pai
Se a fonte for uma fonte filha, esse campo apontará para seu objeto de origem pai. A fonte superior desta hierarquia é referida como a fonte primária.
Uma origem filha não pode ser criada diretamente por meio da API, mas é criada automaticamente pela API quando a pesquisa apropriada é criada.
Estados
unvalidated
- uma sessão nunca foi criada com sucesso contra essa origem, portanto, a API não pode dizer se é uma fonte válida.
active
- a fonte foi validada e está pronta para uso.
deactivated
- o acesso à fonte foi proibido pela organização proprietária.
blocked
- o acesso à fonte foi proibido por um administrador da API.
locked
- o acesso à fonte foi temporariamente restringido pelo serviço externo.
Recuperar GET /sources/{source ID}
Usando cURL
curl https://ricloud-api.reincubate.com/sources/<source ID> \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud source = ricloud.Source.create(<source ID>)
Resposta da amostra
{ "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" }
Listar GET /sources
nome | tipo | descrição |
---|---|---|
organisation | super, ID da organização | Para administradores de API filtrarem por organização. |
user | ID do usuário | Filtrar por usuário associado. |
type | corda | Filtrar por tipo de fonte. |
identifier | corda | Filtrar por identificador de origem. |
state | corda | Filtrar por estado de origem. |
date_created | filtro de data e hora | Filtrar por data de criação do recurso. |
Usando cURL
curl https://ricloud-api.reincubate.com/sources \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud sources = ricloud.Source.list()
Atualizar POST /sources/{source ID}
nome | tipo | descrição |
---|---|---|
state | corda | Atualize o estado de origem. |
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" }'
Usando 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')
Changelog
2020-02-20
- Principal O atributo
children
do objeto de origem agora é um objeto de lista aninhada, em vez de um simples atributo de lista.
2019-10-16
- Adiciona dois novos tipos de fonte:
rirelay.instance
erirelay.source
.