Implementacion de cliente ricloud-py

El cliente ricloud-py es una implementación directa de la interfaz API de ricloud v3 . También incluye algunas implementaciones de muestra de casos de uso comunes, y algunas implementaciones básicas de recuperación de datos de depósitos de almacenamiento de terceros (AWS S3 y Google Cloud Storage).

Instalación

La forma más sencilla de obtener el cliente es instalarlo desde PyPi .

pip install ricloud==3.0.0

También puede obtener el código del repositorio de GitHub .

Configuración

Se key_token un key_token para autenticarse en la API. Si es un cliente existente, póngase en contacto con el servicio de asistencia empresarial para obtener una clave de prueba para la API de ricloud v3 .

ricloud-py se puede configurar de dos maneras:

• A través del atributo token en un módulo ricloud importado.

import ricloud

ricloud.token = '<your key_token>'

• Cree un archivo .ricloud.ini en su directorio de inicio con el siguiente contenido.

[api]
token = <you key_token>

Vea la referencia del archivo .ricloud.ini para más detalles.

Uso

El cliente expone una clase para cada recurso API y un conjunto de métodos para interactuar con ellos.

>>> import ricloud

>>> org = ricloud.Organisation.retrieve()

>>> print(org.name)
My Organisation

>>> org.update(name='Changed Organisation')

>>> print(org.name)
Changed Organisation

Implementaciones de muestra

El cliente incluye implementaciones de muestra para una serie de interacciones comunes.

Se puede acceder a estos a través del comando samples

iCloud

La implementación de muestra de iCloud ofrece una forma rápida de recuperar datos de una cuenta de iCloud a través de la línea de comandos.

Reiniciar relé

El ejemplo del servicio Reincubate Relay implementa un conjunto de comandos necesarios para crear una sesión, configurar una suscripción y activar encuestas manualmente.

Punto final de webhook

El cliente incluye una implementación sencilla de punto final de webhook que escucha las notificaciones de eventos API entrantes e imprime información en la consola.

Se recomienda utilizar una utilidad como ngrok para exponer de manera segura su punto final local a Internet. De forma predeterminada, el punto final de webhook está vinculado al puerto 8080 en su máquina.

ngrok http -bind-tls=true 8080

Puede ver la dirección de su punto final ngrok expuesto públicamente en la fila Forwarding , como https://abcd1234.ngrok.io .

Luego puede iniciar el escucha ejecutando el comando de ricloud event listen . Si su cliente está configurado correctamente, creará automáticamente una configuración de webhook utilizando la URL especificada en el comando y la configurará como la configuración de webhook predeterminada de la clave actualmente en uso.

ricloud event listen --webhook-url https://abcd1234.ngrok.io

.ricloud.ini archivo .ricloud.ini

Seccion: api

token

El token utilizado para autenticarse en los puntos finales de la API.

url

La url base para la API. Predeterminado: https://ricloud-api.reincubate.com .

max_retries

Cuántas veces reintentar una solicitud si falla debido a un error del servidor o de la conexión. Predeterminado: 3

await_for

Agrega el Ricloud-Await con el valor especificado para habilitar el mecanismo de respuesta de espera . Predeterminado: 0

Sección: webhooks

secret

El secreto de configuración de webhook que se utiliza al verificar las cargas útiles de notificación de eventos entrantes. Esto se configura automáticamente si se usa la opción --webhook-url para el comando de ricloud event listen .

delta

La variación permitida entre cuando se envió el evento y cuándo se recibió, en segundos. Predeterminado: 600

Sección: logging

log_level

Sección: samples

output_directory

El directorio de salida predeterminado para cualquier resultado descargado como parte de un script de muestra. Si la ruta del directorio es relativa, se creará en relación con el directorio de trabajo actual.

user_identifier

El cliente creará un recurso de usuario al ejecutar scripts de muestra. El valor predeterminado para el identificador de este usuario es ricloud-py , pero se puede personalizar fácilmente a través de esta opción.

Esto puede ser útil para distinguir el uso entre diferentes desarrolladores dentro de la misma organización, por ejemplo.

[api]
token = <your key_token>
url = https://ricloud-api.reincubate.com
max_retries = 1

[logging]
log_directory = logs
log_level = WARNING

[samples]
output_directory = output
user_identifier = ricloud-py