Schlüssel

Aktualisierte

Ein Schlüssel gewährt über sein token Attribut Zugriff auf die API auf Organisationsebene. Es ist zulässig, im Auftrag seiner Organisation mit allen API-Endpunkten zu interagieren.

Für jede neu erstellte Organisation wird ein Schlüssel generiert.

Attribute

Name Art Beschreibung
id Schlüssel-ID Ressourcenkennung.
resource Zeichenfolge, immer key Ressourcentypbezeichner.
organisation Organisations-ID Die Organisation, zu der dieser Schlüssel gehört.
type Zeichenfolge Eines von: standard , trial .
storage_config Optional, Speicherkonfigurations-ID Die vom Schlüssel verwendete Speicherkonfiguration.
webhook_config Optional, Webhook-Konfigurations-ID Die vom Schlüssel verwendete Webhook-Konfiguration.
token Zeichenfolge Das Authentifizierungsmaterial für diesen Schlüssel. Wird zum Auffüllen des AUTHORIZATION HTTP-Headers in Anforderungen für die API verwendet.
state Zeichenfolge Einer von: active , deactivated , blocked , expired .
date_created Terminzeit Wann wurde die Ressource erstellt.
date_expires optional, datetime Wann läuft der Schlüssel ab? Vor allem gilt für trial Schlüssel Typ.

Typen

standard
der Schlüsseltyp. Jede Organisation hat mindestens eine davon.
trial
Ein Schlüssel, der von einem API-Administrator generiert wird, um der Testversion des Unternehmens Zugriff auf zusätzliche Berechtigungen zu gewähren. Für diese wird normalerweise das Feld date_expires festgelegt.

Speicher- und Webhook-Konfigurationen

Eine Schlüsselressource kann die Standardwerte der Organisation für Speicher und Webhook-Konfiguration überschreiben. Dies kann hilfreich sein, um Ergebnisse und Ereignisbenachrichtigungen auf Umgebungen wie dev und production aufzuteilen.

Zeichen

Der Wert des token Attributs eines Schlüssels kann zur Authentifizierung gegenüber der API im Namen der Eigentümerorganisation verwendet werden.

Diese Werte sollten sicher gespeichert und niemals öffentlich zugänglich gemacht werden.

Zustand

active
der Standardzustand des Schlüssels.
deactivated
Die Eigentümerorganisation hat den Schlüssel deaktiviert.
blocked
Der Schlüssel wurde von einem API-Administrator deaktiviert.
expired
Der Schlüssel ist deaktiviert, da der Testzeitraum abgelaufen ist.

Erstellen Sie POST /keys

Parameter

Name Art Beschreibung
storage_config Speicherkonfigurations-ID Überschreiben Sie die Standardspeicherkonfiguration der Organisation für diesen Schlüssel.
webhook_config Webhook-Konfigurations-ID Überschreiben Sie die Standard-Webhook-Konfiguration der Organisation auf diesem Schlüssel.

CURL verwenden

curl 'https://ricloud-api.reincubate.com/keys' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "storage_config": 2,
}'

Mit Ricloud-Py

import ricloud

key = ricloud.Key.create(storage_config=2)

# OR

storage_config = ricloud.StorageConfig.retrieve(2)

key = ricloud.Key.create(storage_config=storage_config)

GET /keys/{key ID}

CURL verwenden

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

Mit Ricloud-Py

import ricloud

key = ricloud.Key.retrieve(<key ID>)

Liste GET /keys

Parameter

Name Art Beschreibung
type Zeichenfolge Filtern Sie die Schlüssel nach ihrem Typ.
state Zeichenfolge Filtern Sie Schlüssel nach ihrem Status.

CURL verwenden

curl 'https://ricloud-api.reincubate.com/keys?limit=2' \
  -H 'Authorization: Token <your key_token>'

Mit Ricloud-Py

import ricloud

keys = ricloud.Key.list(limit=2)

POST /keys/{key ID}

Parameter

Name Art Beschreibung
storage_config Speicherkonfigurations-ID Aktualisieren Sie die vom Schlüssel verwendete Speicherkonfiguration. Wenn null wird auf den Organisationsstandard zurückgegriffen.
webhook_config Webhook-Konfigurations-ID Aktualisieren Sie die vom Schlüssel verwendete Webhook-Konfiguration. Wenn null wird auf den Organisationsstandard zurückgegriffen.

CURL verwenden

curl 'https://ricloud-api.reincubate.com/keys/<key ID>' \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_config": 2
}'

Mit Ricloud-Py

import ricloud

key = ricloud.Key.update_with_id(<key ID>, webhook_config=2)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.update(webhook_config=2)

POST /keys/{key ID}/rotate

Drehen Sie den Wert des token eines Schlüssels. Obwohl dies nicht erforderlich ist, wird empfohlen, dies ziemlich regelmäßig oder sofort zu tun, wenn der Verdacht besteht, dass das token des Schlüssels kompromittiert wurde.

Parameter

Name Art Beschreibung
force Bool, Standard: False Wenn der aktuelle token Wert sofort deaktiviert werden soll. Wenn nicht, beträgt die aktuelle Rotationsperiode 6 Stunden nach dem Anruf.

CURL verwenden

curl 'https://ricloud-api.reincubate.com/keys/<key ID>/rotate' \
  -X POST \
  -H 'Authorization: Token <your key_token>'

Mit Ricloud-Py

import ricloud

key = ricloud.Key.rotate_with_id(<key ID>)

# OR

key = ricloud.Key.retrieve(<key ID>)

key.rotate()

Wie können wir helfen?

Unser Support-Team hilft Ihnen gerne weiter!

Unsere Bürozeiten sind Montag bis Freitag von 9 bis 17 Uhr GMT. Die Zeit ist aktuell 10:26 nachm. GMT.

Wir bemühen uns, auf alle Mitteilungen innerhalb eines Arbeitstages zu antworten.

Zum Support-Bereich gehen › Wenden Sie sich an das Unternehmensteam ›
Unser großartiges Supportteam

© 2008 - 2019 Reincubate Ltd. Alle Rechte vorbehalten. Registriert in England und Wales #5189175, VAT GB151788978. Reincubate® ist eine eingetragene Marke. Datenschutz. Wir empfehlen die Multi-Faktor-Authentifizierung. Mit Liebe in London gebaut.