ricloud-py client-implementatie

De ricloud-py- client is een eenvoudige implementatie van de ricloud v3 API-interface. Het bevat ook enkele voorbeeldimplementaties van veelvoorkomende use-cases en enkele basisimplementaties van het ophalen van gegevens uit opslagladen van derden (AWS S3 en Google Cloud Storage).

Installatie

De eenvoudigste manier om de client te krijgen, is door hem vanuit PyPi te installeren.

pip install ricloud==3.0.0

Je kunt de code ook krijgen van de GitHub-repo .

Configuratie

Een key_token is vereist om te verifiëren tegen de API. Als u een bestaande klant bent, neemt u contact op met bedrijfsondersteuning om een evaluatiesleutel voor de ricloud v3 API te krijgen.

ricloud-py kan op twee manieren worden geconfigureerd:

• Via het token kenmerk op een geïmporteerde ricloud module.

import ricloud

ricloud.token = '<your key_token>'

• Maak een .ricloud.ini bestand in uw thuismap met de volgende inhoud.

[api]
token = <you key_token>

Raadpleeg de bestandsextensie .ricloud.ini voor meer informatie.

Gebruik

De client stelt een klasse voor elke API-resource en een set methoden voor om ermee te communiceren.

>>> import ricloud

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

>>> print(org.name)
My Organisation

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

>>> print(org.name)
Changed Organisation

Voorbeeldimplementaties

De client bevat voorbeeldimplementaties voor een aantal veelvoorkomende interacties.

Deze zijn toegankelijk via de opdracht samples

iCloud

De iCloud-voorbeeldimplementatie biedt een snelle manier om gegevens op te halen uit een iCloud-account via de opdrachtregel.

Relay opnieuw incuberen

Het voorbeeld van Reincubate Relay-service implementeert een set opdrachten die nodig zijn om een sessie te maken, een abonnement in te stellen en handmatig peilingen te activeren.

Webhook eindpunt

De client bevat een eenvoudige webhook-eindpuntimplementatie die luistert naar inkomende API-gebeurtenismeldingen en informatie naar de console afdrukt.

Het wordt aanbevolen om een hulpprogramma zoals ngrok te gebruiken om uw lokale eindpunt veilig bloot te stellen aan internet. Het webhook-eindpunt is standaard gebonden aan poort 8080 op uw machine.

ngrok http -bind-tls=true 8080

U kunt het adres van uw publiekelijk zichtbare ngrok-eindpunt in de rij Forwarding , zoals https://abcd1234.ngrok.io .

Vervolgens kunt u de luisteraar opstarten door het luistercommando ricloud event listen voeren. Als uw client correct is geconfigureerd, maakt deze automatisch een webhook-configuratie met behulp van de URL die is opgegeven in de opdracht en wordt deze ingesteld als de standaard webhook-configuratie van de sleutel die momenteel wordt gebruikt.

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

.ricloud.ini bestand verwijzing

Sectie: api

token

Het token dat wordt gebruikt om te verifiëren voor de eindpunten van de API.

url

De basis-URL voor de API. Standaard: https://ricloud-api.reincubate.com .

max_retries

Hoe vaak een poging opnieuw proberen als het mislukt vanwege een server- of verbindingsfout. Standaard: 3

await_for

Voegt de Ricloud-Await header met de opgegeven waarde toe om het wachten op responsmechanisme in te schakelen. Standaard: 0

Sectie: webhooks

secret

Het webhook-configuratiegeheim dat moet worden gebruikt bij het verifiëren van inkomende payloads voor gebeurtenismeldingen. Dit wordt automatisch ingesteld als u de optie --webhook-url voor de ricloud event listen van de ricloud event listen .

delta

De variatie toegestaan tussen wanneer de gebeurtenis is verzonden en wanneer deze is ontvangen, in seconden. Standaard: 600

Sectie: logging

log_level

Sectie: samples

output_directory

De standaarduitvoermap voor alle resultaten die zijn gedownload als onderdeel van een voorbeeldscript. Als het directorypad relatief is, wordt het relatief ten opzichte van de huidige werkmap gemaakt.

user_identifier

De client maakt een gebruikersresource bij het uitvoeren van voorbeeldscripts. De standaardwaarde voor de identificatie van deze gebruiker is ricloud-py , maar kan via deze optie eenvoudig worden aangepast.

Dit kan handig zijn om bijvoorbeeld het gebruik van verschillende ontwikkelaars binnen dezelfde organisatie te onderscheiden.

[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