Implémentation du client ricloud-py

Le client ricloud-py est une implémentation simple de l'interface API de ricloud v3 . Il inclut également des exemples d'implémentation de cas d'utilisation courants et des implémentations de base de récupération de données à partir de compartiments de stockage tiers (AWS S3 et Google Cloud Storage).

Installation

Le moyen le plus simple d’obtenir le client est de l’installer à partir de PyPi .

pip install ricloud==3.0.0

Vous pouvez également obtenir le code auprès du dépôt GitHub .

Configuration

Un key_token est requis pour s'authentifier auprès de l'API. Si vous êtes un client existant, contactez le support technique de l'entreprise pour obtenir une clé d'essai pour l'API ricloud v3 .

ricloud-py peut être configuré de deux manières:

• Via l'attribut token sur un module ricloud importé.

import ricloud

ricloud.token = '<your key_token>'

• Créez un fichier .ricloud.ini dans votre répertoire personnel avec le contenu suivant.

[api]
token = <you key_token>

Voir la référence du fichier .ricloud.ini pour plus de détails.

Usage

Le client expose une classe pour chaque ressource API et un ensemble de méthodes pour interagir avec elles.

>>> import ricloud

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

>>> print(org.name)
My Organisation

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

>>> print(org.name)
Changed Organisation

Exemples d'implémentations

Le client comprend des exemples d’implémentation pour un certain nombre d’interactions courantes.

Vous pouvez y accéder via la commande samples

iCloud

L'exemple d'implémentation iCloud offre un moyen rapide de récupérer des données d'un compte iCloud via la ligne de commande.

Relais de réincubation

L'exemple de service Reincubate Relay implémente un ensemble de commandes permettant de créer une session, de configurer un abonnement et de déclencher manuellement des interrogations.

Point de terminaison Webhook

Le client comprend une implémentation Webhook endpoint simple qui écoute les notifications d'événements d'API entrantes et imprime des informations sur la console.

Il est recommandé d’utiliser un utilitaire tel que ngrok pour exposer en toute sécurité votre point de terminaison local à Internet. Par défaut, le terminal Webhook est lié au port 8080 sur votre ordinateur.

ngrok http -bind-tls=true 8080

Vous pouvez voir l'adresse de votre point de terminaison ngrok exposé publiquement dans la ligne Forwarding , comme https://abcd1234.ngrok.io .

Vous pouvez ensuite démarrer le programme d'écoute en exécutant la commande ricloud event listen . Si votre client est configuré correctement, il créera automatiquement une configuration Webhook à l'aide de l'URL spécifiée dans la commande et la définira comme configuration Webhook par défaut de la clé en cours d'utilisation.

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

.ricloud.ini fichier .ricloud.ini

Section: api

token

Le jeton utilisé pour s'authentifier auprès des ordinateurs d'extrémité de l'API.

url

L'URL de base pour l'API. Par défaut: https://ricloud-api.reincubate.com .

max_retries

Combien de fois réessayer une demande si elle échoue à cause d'une erreur de serveur ou de connexion. Par défaut: 3

await_for

Ajoute l'en Ricloud-Await tête Ricloud-Await avec la valeur spécifiée à activer au mécanisme de réponse en attente . Par défaut: 0

Section: webhooks

secret

Le secret de configuration webhook à utiliser lors de la vérification des charges utiles de notification d'événements entrants. Ceci est défini automatiquement si vous utilisez l'option --webhook-url avec la commande ricloud event listen .

delta

Écart autorisé entre le moment où l'événement a été envoyé et le moment où il a été reçu, en secondes. Par défaut: 600

Section: logging

log_level

Section: samples

output_directory

Répertoire de sortie par défaut pour tous les résultats téléchargés dans le cadre d'un exemple de script. Si le chemin du répertoire est relatif, il sera créé par rapport au répertoire de travail actuel.

user_identifier

Le client créera une ressource utilisateur lors de l'exécution des exemples de scripts. La valeur par défaut pour l'identifiant de cet utilisateur est ricloud-py , mais peut être facilement personnalisée via cette option.

Cela peut être utile pour distinguer l'utilisation entre différents développeurs au sein de la même organisation, par exemple.

[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