Clés

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

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 .

Configuration

La configuration au niveau de la clé peut être définie sur l'attribut config de la clé. Pour le moment, cela n'accepte que publish_source_files , lié au mécanisme de publication des fichiers source .

Configurations de stockage et de 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

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

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

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

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