Llaves

Una clave da acceso a la API en el nivel de la organización a través de su atributo token . Se permite interactuar con todos los puntos finales de API en nombre de su organización.

Se genera una clave para cada organización recién creada.

Atributos

Tipos

standard

el tipo de clave Cada organización tiene al menos uno de estos.

trial

una clave generada por un administrador de API para dar a la organización acceso de prueba a permisos adicionales. Estos tendrán típicamente el campo date_expires establecido.

Configuración

La configuración a nivel de clave se puede establecer en el atributo de config de la clave. Por el momento, esto solo acepta publish_source_files , relacionado con el mecanismo de publicación de archivos fuente .

Configuraciones de almacenamiento y webhook

Un recurso clave puede anular los valores predeterminados de la organización para el almacenamiento y la configuración de webhook. Esto puede ser útil para dividir los resultados y la notificación de eventos entre entornos como desarrollo y producción.

Simbólico

El valor del atributo token de una clave se puede usar para autenticarse en la API en nombre de la organización propietaria.

Estos valores deben almacenarse de forma segura y nunca exponerse públicamente.

Estado

active

El estado estándar de la llave.

deactivated

La organización propietaria ha desactivado la clave.

blocked

la clave ha sido desactivada por un administrador de API.

expired

La clave está desactivada a medida que el período de prueba ha pasado.

Crear POST /keys

Parámetros

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

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

Recuperar GET /keys/{key ID}

Usando cURL

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

Utilizando ricloud-py

import ricloud

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

Lista GET /keys

Parámetros

Usando cURL

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

Utilizando ricloud-py

import ricloud

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

Actualizar POST /keys/{key ID}

Parámetros

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

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

Rotar POST /keys/{key ID}/rotate

Gire el valor del token de una clave. Aunque no es obligatorio, se recomienda hacer esto de forma bastante regular o inmediatamente si se sospecha que el token la clave ha sido comprometido.

Parámetros

Usando cURL

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

Utilizando ricloud-py

import ricloud

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

# OR

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

key.rotate()