Sources

Mis à jour

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

prénom type la description
id ID source Identifiant de ressource.
resource chaîne, toujours source Spécificateur de type de ressource.
user identifiant d'utilisateur L'utilisateur associé à cette source.
type chaîne Le type de cette source, par exemple icloud.account .
identifier chaîne Un identifiant unique pour la source dans le cadre de son service.
parent optionnel, ID source Rempli si la source est un enfant d'un autre.
children liste d'objets contenant des ressources sources Contient toutes les sous-sources de la source.
state chaîne Un des éléments suivants: non unvalidated , active , deactivated , blocked , locked .
date_created date / heure Quand la ressource a été créée.

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

prénom type la description
organisation super, identifiant d'organisation Pour que les administrateurs d'API filtrent par organisation.
user identifiant d'utilisateur Filtrer par utilisateur associé.
type chaîne Filtrer par type de source.
identifier chaîne Filtrer par identifiant de source.
state chaîne Filtrer par état source.
date_created filtre datetime Filtrer par date de création de la ressource.

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}

Nom type la description
state chaîne Mettez à jour l'état source.

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 .

Comment pouvons nous aider?

Notre équipe de support est là pour vous aider!

Nos bureaux sont ouverts du lundi au vendredi, de 9 h à 17 h GMT. L’heure est actuellement 12:30 Matin GMT.

Notre objectif est de répondre à tous les messages en un jour ouvrable.

Notre superbe équipe de support

© 2008 - 2024 Reincubate Ltd. Tous droits réservés. Enregistré en Angleterre et au Pays de Galles #5189175, VAT GB151788978. Reincubate® et Camo® sont des marques déposées. Politique de confidentialité & termes.