Keys

bijgewerkt
Cover image for: Keys

Een sleutel geeft toegang tot de API op organisatieniveau via zijn token . Het is toegestaan om te communiceren met alle API-eindpunten namens de organisatie.

Voor elke nieuw gecreëerde organisatie wordt een sleutel gegenereerd.

attributen

naam type Omschrijving
id sleutel ID Bron-ID.
resource string, altijd key Specificatie middelenbron.
organisation organisatie ID De organisatie waar deze sleutel toe behoort.
type draad Een van: standard , trial .
config genest voorwerp Sleutelspecifieke configuratie-instellingen.
storage_config optioneel, opslagconfiguratie ID De opslagconfiguratie die door de sleutel wordt gebruikt.
webhook_config optioneel, webhook config-ID De webhook-configuratie die door de sleutel wordt gebruikt.
token draad Het auth-materiaal voor deze sleutel. Wordt gebruikt om de AUTHORIZATION HTTP-header te vullen in verzoeken tegen de API.
state draad Eén van: active , deactivated , blocked , expired .
date_created datum Tijd Wanneer de resource is gemaakt.
date_expires optioneel, datetime Wanneer de sleutel zal verlopen. Hoofdzakelijk van toepassing op trial .

Types

standard
het type sleutel. Elke organisatie heeft er minstens één.
trial
een sleutel gegenereerd door een API-beheerder om de organisatie proeftoegang tot aanvullende rechten te geven. Deze hebben meestal het veld date_expires .

Configuratie

Configuratie op sleutelniveau kan worden ingesteld op het config van de sleutel. Op dit moment accepteert dit alleen publish_source_files , gerelateerd aan het mechanisme voor het publiceren van bronbestanden .

Opslag- en webhookconfiguraties

Een belangrijke bron kan de standaardwaarden van de organisatie voor opslag en webhook-configuratie overschrijven. Dit kan handig zijn om resultaten en gebeurtenismeldingen te splitsen tussen omgevingen als ontwikkelaar en productie.

Token

De waarde van het token van een sleutel kan worden gebruikt voor verificatie ten opzichte van de API namens de eigenaarorganisatie.

Deze waarden moeten veilig worden opgeslagen en mogen nooit openbaar worden getoond.

Staat

active
de standaardstatus van de sleutel.
deactivated
de eigenaar heeft de sleutel uitgeschakeld.
blocked
de sleutel is uitgeschakeld door een API-beheerder.
expired
de sleutel is uitgeschakeld als de proefperiode voorbij is.

Maak POST /keys

parameters

naam type Omschrijving
storage_config opslagconfiguratie-ID Negeer de standaardopslagconfiguratie van de organisatie op deze sleutel.
webhook_config webhook configuratie-ID Negeer de standaard webhookconfiguratie van de organisatie op deze sleutel.

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

# OR

storage_config = ricloud.StorageConfig.retrieve(2)

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

Ophalen GET /keys/{key ID}

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Lijst GET /keys

parameters

naam type Omschrijving
type snaar Filter sleutels op type.
state snaar Filter sleutels op hun status.

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

Update POST /keys/{key ID}

parameters

naam type Omschrijving
storage_config opslagconfiguratie-ID Werk de opslagconfiguratie bij die door de sleutel wordt gebruikt. Als null terugvalt naar de standaardinstelling van de organisatie.
webhook_config webhook configuratie-ID Werk de webhook-configuratie bij die door de sleutel wordt gebruikt. Als null terugvalt naar de standaardinstelling van de organisatie.

CURL gebruiken

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

Ricloud-py gebruiken

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)

Roteer POST /keys/{key ID}/rotate

Roteer de waarde van het token van een sleutel. Hoewel dit niet verplicht is, wordt het aangeraden dit op een vrij regelmatige basis of onmiddellijk te doen als wordt vermoed dat het token de sleutel is aangetast.

parameters

naam type Omschrijving
force bool, standaard: False Als de huidige token onmiddellijk moet worden ingetrokken. Zo niet, dan is de huidige rotatieperiode 6 uur nadat de oproep is gedaan.

CURL gebruiken

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

Ricloud-py gebruiken

import ricloud

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

# OR

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

key.rotate()

Hoe kunnen we helpen?

Ons ondersteuningsteam is er om u te helpen!

Onze kantooruren zijn van maandag tot vrijdag van 09.00 tot 17.00 uur GMT. De tijd is momenteel 1:07 AM GMT.

We streven ernaar om alle berichten binnen één werkdag te beantwoorden.

Ons geweldige ondersteuningsteam

© 2008 - 2022 Reincubate Ltd. Alle rechten voorbehouden. Geregistreerd in Engeland en Wales #5189175, VAT GB151788978. Reincubate® en Camo® zijn geregistreerde handelsmerken. Privacybeleid & termen. Gebouwd met in Londen.