Quellen

Eine Quelle repräsentiert eine Datenquelle von einem Dienst. Ein iCloud-Konto ist beispielsweise eine Quelle des iCloud-Dienstes.

Quellen können rirelay.source Quellen haben, z. B. eine rirelay.instance Quelle mit mehreren rirelay.source Quellen, auf die einzeln abgezielt werden kann.

Attribute

Typen

Derzeit unterstützte Typen sind:

• icloud.account , die primäre Quelle im iCloud-Dienst.
• rirelay.instance , die primäre Quelle für den rirelay-Dienst. Entspricht einer Instanz der Reincubate Relay-Anwendung.
• rirelay.source , eine rirelay.instance Quelle von rirelay.instance . Entspricht einem Gerät, auf das die übergeordnete Reincubate Relay-App Zugriff hat.

Kennung

Der Wert des identifier einer Quelle identifiziert sie eindeutig innerhalb ihres Dienstes. Für ein iCloud-Konto ist dies der Benutzername. Für eine App-Instanz von Reincubate Relay ist dies die Instanz-ID.

Elternteil

Wenn die Quelle eine untergeordnete Quelle ist, zeigt dieses Feld auf das übergeordnete Quellobjekt. Die oberste Quelle in dieser Hierarchie wird als primäre Quelle bezeichnet.

Eine untergeordnete Quelle kann nicht direkt über die API erstellt werden, sondern wird automatisch von der API erstellt, wenn die entsprechende Abfrage erstellt wird.

Zustände

unvalidated

Für diese Quelle wurde noch nie eine Sitzung erfolgreich erstellt. Daher kann die API nicht feststellen, ob es sich um eine gültige Quelle handelt.

active

Die Quelle wurde validiert und ist einsatzbereit.

deactivated

Der Zugriff auf die Quelle wurde von der besitzenden Organisation verboten.

blocked

Der Zugriff auf die Quelle wurde von einem API-Administrator verboten.

locked

Der Zugriff auf die Quelle wurde vom externen Dienst vorübergehend eingeschränkt.

GET /sources/{source ID}

CURL verwenden

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

Mit Ricloud-Py

import ricloud

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

Beispielantwort

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

CURL verwenden

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

Mit Ricloud-Py

import ricloud

sources = ricloud.Source.list()

POST /sources/{source ID}

CURL verwenden

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

Mit 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')

Änderungsprotokoll

2020-02-20

• Major Das children Attribut des Quellobjekts ist jetzt ein verschachteltes Listenobjekt und kein einfaches Listenattribut mehr.

2019-10-16

• Fügt zwei neue rirelay.instance rirelay.source : rirelay.instance und rirelay.source .