Clés

Mis à jour

Une clé donne accès à l'API au niveau de l'organisation via son attribut de token . Il est autorisé à interagir avec tous les points de terminaison de l'API pour le compte de son organisation.

Une clé est générée pour chaque organisation nouvellement créée.

Les attributs

prénom type la description
id ID clé Identifiant de ressource.
resource chaîne, toujours key Spécificateur de type de ressource.
organisation ID d'organisation L'organisation à laquelle cette clé appartient.
type chaîne L'un des suivants: standard , trial .
storage_config facultatif, ID de configuration de stockage La configuration de stockage utilisée par la clé.
webhook_config optionnel, identifiant de configuration webhook La configuration webhook utilisée par la clé.
token chaîne Le matériel d'authentification pour cette clé. Il est utilisé pour remplir l' AUTHORIZATION tête HTTP dans les requêtes contre l'API.
state chaîne Un des éléments suivants: active , deactivated , blocked , expired .
date_created date / heure Quand la ressource a été créée.
date_expires facultatif, date / heure Lorsque la clé expirera. S'applique principalement aux clés de type d' trial .

Les types

standard
le type de clé. Chaque organisation en a au moins un.
trial
une clé générée par un administrateur d'API pour donner à l'organisation un accès d'évaluation à des autorisations supplémentaires. Celles-ci auront généralement le champ date_expires .

Stockage et config webhook

Une ressource clé peut remplacer les valeurs par défaut de l'organisation pour le stockage et la configuration webhook. Cela peut être utile pour fractionner les résultats et la notification d'événements entre des environnements tels que le développement et la production.

Jeton

La valeur de l'attribut de token d'une clé peut être utilisée pour s'authentifier auprès de l'API pour le compte de l'organisation propriétaire.

Ces valeurs doivent être stockées de manière sécurisée et ne jamais être exposées publiquement.

Etat

active
l'état standard de la clé.
deactivated
l'organisation propriétaire a désactivé la clé.
blocked
la clé a été désactivée par un administrateur de l'API.
expired
la clé est désactivée car la période d'essai est terminée.

Créer un POST /keys

Paramètres

prénom type la description
storage_config ID de configuration de stockage Remplacez la configuration de stockage par défaut de l'organisation sur cette clé.
webhook_config identifiant de configuration webhook Remplacez la configuration Webhook par défaut de l'organisation sur cette clé.

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

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

Récupérer GET /keys/{key ID}

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

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

Liste GET /keys

Paramètres

prénom type la description
type chaîne Filtrer les clés par leur type.
state chaîne Filtrer les clés par leur état.

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

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

Mettre à jour le POST /keys/{key ID}

Paramètres

prénom type la description
storage_config ID de configuration de stockage Mettez à jour la configuration de stockage utilisée par la clé. Si null reviendra à l'organisation par défaut.
webhook_config identifiant de configuration webhook Mettez à jour la configuration webhook utilisée par la clé. Si null reviendra à l'organisation par défaut.

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

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

Faire pivoter le POST /keys/{key ID}/rotate

Faites pivoter la valeur du token d'une clé. Bien que cela ne soit pas obligatoire, il est recommandé de le faire de manière assez régulière ou immédiatement si l'on soupçonne que le token la clé a été compromis.

Paramètres

prénom type la description
force bool, défaut: False Si la valeur actuelle du token doit être immédiatement annulée. Si ce n'est pas le cas, la période de rotation actuelle est de 6 heures après l'appel.

Utiliser cURL

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

Utiliser ricloud-py

import ricloud

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

# OR

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

key.rotate()

Comment pouvons nous aider?

Notre équipe de support est là pour vous aider!

Nos bureaux sont ouverts du lundi au vendredi, de 9 h à 17 h GMT. L’heure est actuellement 9:58 Après-midi GMT.

Notre objectif est de répondre à tous les messages en un jour ouvrable.

Aller à la section support › Contacter l'équipe de l'entreprise ›
Notre superbe équipe de support

© 2008 - 2019 Reincubate Ltd. Tous droits réservés. Enregistré en Angleterre et au Pays de Galles #5189175, VAT GB151788978. Reincubate® est une marque déposée. Confidentialité et modalités. Nous recommandons l'authentification multi-facteurs. Construit avec à Londres.