chiavi

aggiornato

Una chiave consente l'accesso all'API a livello di organizzazione tramite l'attributo token . È consentito interagire con tutti gli endpoint API per conto della sua organizzazione.

Viene generata una chiave per ciascuna organizzazione appena creata.

attributi

nome genere descrizione
id ID chiave Identificatore di risorse
resource stringa, sempre key Specificatore del tipo di risorsa.
organisation ID dell'organizzazione L'organizzazione a cui appartiene questa chiave.
type stringa Uno di: standard , trial .
storage_config facoltativo, ID di configurazione di archiviazione La configurazione di archiviazione utilizzata dalla chiave.
webhook_config facoltativo, webhook config ID La configurazione del webhook usata dalla chiave.
token stringa Il materiale dell'autore per questa chiave. Viene utilizzato per popolare l' AUTHORIZATION HTTP nelle richieste contro l'API.
state stringa Uno di: active , deactivated , blocked , expired .
date_created appuntamento Quando la risorsa è stata creata.
date_expires facoltativo, datetime Quando la chiave scadrà. Si applica principalmente alle chiavi del tipo di trial .

tipi

standard
il tipo di chiave. Ogni organizzazione ha almeno uno di questi.
trial
una chiave generata da un amministratore API per consentire all'organizzazione di accedere a autorizzazioni aggiuntive. Questi in genere hanno il campo date_expires impostato.

Storage e configs webhook

Una risorsa chiave può sostituire i valori predefiniti dell'organizzazione per la memorizzazione e la configurazione di webhook. Questo può essere utile per dividere i risultati e la notifica degli eventi tra ambienti come dev e produzione.

Gettone

Il valore dell'attributo token di una chiave può essere utilizzato per l'autenticazione con l'API per conto dell'organizzazione proprietaria.

Questi valori dovrebbero essere archiviati in modo sicuro e non essere mai esposti pubblicamente.

Stato

active
lo stato standard della chiave.
deactivated
l'organizzazione proprietaria ha disattivato la chiave.
blocked
la chiave è stata disabilitata da un amministratore API.
expired
la chiave è disabilitata al termine del periodo di prova.

Crea POST /keys

parametri

nome genere descrizione
storage_config ID di configurazione di archiviazione Sostituisci la configurazione di archiviazione predefinita dell'organizzazione su questa chiave.
webhook_config ID di configurazione webhook Sostituisci la configurazione webhook predefinita dell'organizzazione su questa chiave.

Utilizzando cURL

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

Usando 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)

Recupera GET /keys/{key ID}

Utilizzando cURL

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

Usando ricloud-py

import ricloud

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

Elenca GET /keys

parametri

nome genere descrizione
type stringa Filtra le chiavi in base al loro tipo.
state stringa Filtra le chiavi in base al loro stato.

Utilizzando cURL

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

Usando ricloud-py

import ricloud

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

Aggiorna POST /keys/{key ID}

parametri

nome genere descrizione
storage_config ID di configurazione di archiviazione Aggiorna la configurazione di archiviazione utilizzata dalla chiave. Se null tornerà all'organizzazione predefinita.
webhook_config ID di configurazione webhook Aggiorna la configurazione del webhook utilizzata dalla chiave. Se null tornerà all'organizzazione predefinita.

Utilizzando cURL

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

Usando 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)

Ruota POST /keys/{key ID}/rotate

Ruota il valore del token di una chiave. Sebbene non sia richiesto, si consiglia di farlo su base abbastanza regolare o immediatamente se si sospetta che il token della chiave sia stato compromesso.

parametri

nome genere descrizione
force bool, predefinito: False Se il valore del token corrente deve essere rimosso immediatamente. In caso contrario, il periodo di rotazione corrente è 6 ore dopo la chiamata.

Utilizzando cURL

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

Usando ricloud-py

import ricloud

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

# OR

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

key.rotate()

Come possiamo aiutare?

Il nostro team di supporto è qui per aiutarti!

I nostri orari di ufficio sono dal lunedì al venerdì, dalle 9:00 alle 17:00 GMT. L'ora è attualmente 6:22 PM GMT.

Miriamo a rispondere a tutti i messaggi entro un giorno lavorativo.

Vai alla sezione di supporto › Contatta il team aziendale ›
Il nostro fantastico team di supporto

© 2008 - 2019 Reincubate Ltd. Tutti i diritti riservati. Registrato in Inghilterra e Galles #5189175, VAT GB151788978. Reincubate® è un marchio registrato. Termini e Condizioni. Raccomandiamo 2FA. Costruito con a Londra.