fonti
Un'origine rappresenta una fonte di dati da un servizio. Ad esempio, un account iCloud è una fonte del servizio iCloud.
Le fonti possono avere origini figlio, come una fonte rirelay.instance
con più fonti rirelay.source
che possono essere rirelay.source
come target individualmente.
attributi
nome | genere | descrizione |
---|---|---|
id | ID sorgente | Identificatore di risorse |
resource | stringa, sempre source | Specificatore del tipo di risorsa. |
user | ID utente | L'utente associato a questa fonte. |
type | corda | Il tipo di questa fonte, ad esempio icloud.account . |
identifier | corda | Un identificatore univoco per l'origine nell'ambito del suo servizio. |
parent | facoltativo, ID sorgente | Compilato se la fonte è figlia di un altro. |
children | oggetto elenco contenente risorse di origine | Contiene eventuali fonti secondarie della fonte. |
state | stringa | Uno di: unvalidated , active , deactivated , blocked , locked . |
date_created | appuntamento | Quando la risorsa è stata creata. |
tipi
I tipi attualmente supportati includono:
-
icloud.account
, la fonte principale sul servizio iCloud. -
rirelay.instance
, la fonte primaria sul servizio rirelay. Corrisponde a un'istanza dell'applicazione Reincubate Relay. -
rirelay.source
, una fonte figlio dirirelay.instance
. Corrisponde a un dispositivo a cui l'app genitore Reincubate Relay ha accesso.
Identifier
Il valore dell'attributo identifier
di una sorgente lo identifica in modo univoco all'interno del suo servizio. Per un account iCloud questo sarebbe il nome utente. Per un'istanza dell'app Reincubate Relay sarebbe l'ID istanza.
Genitore
Se la sorgente è un'origine figlio, questo campo punterà al suo oggetto sorgente genitore. La fonte principale in questa gerarchia è indicata come fonte principale.
Una fonte figlio non può essere creata direttamente tramite l'API, ma viene creata automaticamente dall'API quando viene creato il poll appropriato.
stati
unvalidated
- una sessione non è mai stata creata con successo contro questa fonte, quindi l'API non può dire se è una fonte valida.
active
- la fonte è stata convalidata ed è pronta per l'uso.
deactivated
- l'accesso alla fonte è stato vietato dall'organizzazione proprietaria.
blocked
- l'accesso alla fonte è stato vietato da un amministratore API.
locked
- l'accesso alla fonte è stato temporaneamente limitato dal servizio esterno.
Recupera GET /sources/{source ID}
Utilizzando 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>)
Risposta del campione
{ "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" }
Elenca GET /sources
nome | genere | descrizione |
---|---|---|
organisation | super, ID organizzazione | Per gli amministratori API filtrare in base all'organizzazione. |
user | ID utente | Filtra per utente associato. |
type | stringa | Filtra per tipo di origine. |
identifier | stringa | Filtra per identificatore di origine. |
state | stringa | Filtra per stato di origine. |
date_created | filtro datetime | Filtra per data di creazione della risorsa. |
Utilizzando cURL
curl https://ricloud-api.reincubate.com/sources \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud sources = ricloud.Source.list()
Aggiorna POST /sources/{source ID}
nome | genere | descrizione |
---|---|---|
state | corda | Aggiorna lo stato di origine. |
Utilizzando 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
- Maggiore L'attributo
children
dell'oggetto di origine è ora un oggetto elenco nidificato, anziché un semplice attributo elenco.
2019/10/16
- Aggiunge due nuovi tipi di sorgente:
rirelay.instance
erirelay.source
.