Llaves

Actualizado

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

nombre tipo descripción
id ID de clave Identificador de recursos.
resource cadena, siempre key Especificador de tipo de recurso.
organisation ID de organización La organización a la que pertenece esta clave.
type cuerda Uno de: standard , trial .
storage_config opcional, ID de configuración de almacenamiento La configuración de almacenamiento utilizada por la clave.
webhook_config opcional, ID de configuración de webhook La configuración webhook utilizada por la clave.
token cuerda El material de autenticación para esta clave. Se utiliza para rellenar el encabezado HTTP de AUTHORIZATION en solicitudes contra la API.
state cuerda Uno de: active , deactivated , blocked , expired .
date_created fecha y hora Cuando el recurso fue creado.
date_expires opcional, fecha y hora Cuando la clave expirará. Principalmente se aplica a las claves de tipo de trial .

Los 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.

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

nombre tipo descripción
storage_config ID de configuración de almacenamiento Anular la configuración de almacenamiento predeterminada de la organización en esta clave.
webhook_config ID de configuración de webhook Anular la configuración de webhook predeterminada de la organización en esta clave.

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

nombre tipo descripción
type cuerda Filtrar claves por su tipo.
state cuerda Filtrar las claves por su estado.

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

nombre tipo descripción
storage_config ID de configuración de almacenamiento Actualiza la configuración de almacenamiento utilizada por la clave. Si es null volverá a estar predeterminado en la organización.
webhook_config ID de configuración de webhook Actualiza la configuración de webhook utilizada por la clave. Si es null volverá a estar predeterminado en la organización.

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

nombre tipo descripción
force bool, por defecto: False Si el valor del token actual debe ser desautorizado inmediatamente. De lo contrario, el período de rotación actual es de 6 horas después de realizada la llamada.

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

¿Cómo podemos ayudar?

¡Nuestro equipo de soporte está aquí para ayudar!

Nuestro horario de atención es de lunes a viernes de 9 a.m. a 5 p.m. GMT. El tiempo es actualmente 9:24 PM GMT.

Intentamos responder todos los mensajes en un plazo de un día laboral.

Ir a la sección de soporte › Póngase en contacto con el equipo de la empresa. ›
Nuestro increíble equipo de soporte.

© 2008 - 2019 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® es una marca registrada. Términos y privacidad. Recomendamos la autenticación de múltiples factores. Construido con en Londres.