Sources

Une source représente une source de données d'un service. Par exemple, un compte iCloud est une source du service iCloud.

Les sources peuvent avoir des sources enfants, comme une source rirelay.instance ayant plusieurs sources rirelay.source qui peuvent être ciblées individuellement.

Les attributs

Les types

Les types actuellement supportés incluent:

• icloud.account , la source principale du service iCloud.
• rirelay.instance , la principale source du service de rirelay. Correspond à une instance de l'application Reincubate Relay.
• rirelay.source , une source enfant de rirelay.instance . Correspond à un appareil auquel l'application parent Reincubate Relay a accès.

Identifiant

La valeur de l'attribut d'identifiant d'une source l' identifier manière unique au sein de son service. Pour un compte iCloud, ce serait le nom d'utilisateur. Pour une instance d'application Reincubate Relay, il s'agirait de l'ID d'instance.

Parent

Si la source est une source enfant, ce champ pointe vers son objet source parent. La source supérieure de cette hiérarchie est appelée source principale.

Une source enfant ne peut pas être créée directement via l'API, mais est automatiquement créée par l'API lorsque le sondage approprié est créé.

États

unvalidated

une session n'a jamais été créée avec succès pour cette source. Par conséquent, l'API ne peut pas dire s'il s'agit d'une source valide.

active

la source a été validée et est prête à être utilisée.

deactivated

l'accès à la source a été interdit par l'organisation propriétaire.

blocked

l'accès à la source a été interdit par un administrateur de l'API.

locked

l'accès au source a été temporairement limité par le service externe.

Récupérer GET /sources/{source ID}

Utiliser cURL

curl https://ricloud-api.reincubate.com/sources/<source ID> \
  -H 'Authorization: Token <your key_token>'

Utiliser ricloud-py

import ricloud

source = ricloud.Source.create(<source ID>)

Exemple de réponse

{
  "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"
}

Liste GET /sources

Utiliser cURL

curl https://ricloud-api.reincubate.com/sources \
  -H 'Authorization: Token <your key_token>'

Utiliser ricloud-py

import ricloud

sources = ricloud.Source.list()

Mettre à jour le POST /sources/{source ID}

Utiliser 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"
}'

Utiliser 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

• Majeur L'attribut children de l'objet source est maintenant un objet de liste imbriqué, plutôt qu'un simple attribut de liste.

2019-10-16

• Ajoute deux nouveaux types de source: rirelay.instance et rirelay.source .