bronnen

Een bron vertegenwoordigt een gegevensbron van een service. Een iCloud-account is bijvoorbeeld een bron van de iCloud-service.

Bronnen kunnen onderliggende bronnen hebben, zoals een rirelay.instance bron met meerdere rirelay.source bronnen die individueel kunnen worden getarget.

attributen

Types

Momenteel ondersteunde typen zijn:

• icloud.account , de primaire bron van de iCloud-service.
• rirelay.instance , de primaire bron van de rirelay-service. Komt overeen met een exemplaar van de Reincubate Relay-toepassing.
• rirelay.source , een onderliggende bron van rirelay.instance . Komt overeen met een apparaat waartoe de bovenliggende Reincubate Relay-app toegang heeft.

Identificatie

De waarde van het identifier van een bron identificeert het uniek binnen zijn service. Voor een iCloud-account zou dit de gebruikersnaam zijn. Voor een Reincubate Relay-app-instantie zou dit de instantie-ID zijn.

Ouder

Als de bron een onderliggende bron is, verwijst dit veld naar het bovenliggende bronobject. De topbron in deze hiërarchie wordt de primaire bron genoemd.

Een onderliggende bron kan niet rechtstreeks via de API worden gemaakt, maar wordt automatisch door de API gemaakt wanneer de juiste poll wordt gemaakt.

Staten

unvalidated

een sessie is nooit met succes gemaakt tegen deze bron, daarom kan de API niet zeggen of het een geldige bron is.

active

de bron is gevalideerd en klaar voor gebruik.

deactivated

toegang tot de bron is verboden door de eigenaarorganisatie.

blocked

toegang tot de bron is verboden door een API-beheerder.

locked

toegang tot de bron is tijdelijk beperkt door de externe service.

Ophalen GET /sources/{source ID}

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Voorbeeldantwoord

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

Lijst GET /sources

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

sources = ricloud.Source.list()

Update POST /sources/{source ID}

CURL gebruiken

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

Ricloud-py gebruiken

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

• Belangrijk Het kenmerk children van het bronobject is nu een genest lijstobject in plaats van een eenvoudig lijstkenmerk.

16-10-2019

• Voegt twee nieuwe rirelay.instance : rirelay.instance en rirelay.source .