ricloud-pyクライアントの実装

ricloud-pyクライアントは、 ricloud v3 APIインターフェースの直接的な実装です。また、一般的なユースケースのサンプル実装、およびサードパーティのストレージバケット（AWS S3およびGoogle Cloud Storage）からのデータ取得の基本的な実装も含まれます。

インストール

クライアントを取得する最も簡単な方法はPyPiからインストールすることです 。

pip install ricloud==3.0.0

GitHubリポジトリからコードを入手することもできます。

設定

APIに対する認証にはkey_tokenが必要です。既存のお客様は、 エンタープライズサポートに連絡して、 ricloud v3 APIのトライアルキーを入手してください 。

ricloud-pyは2つの方法で設定できます。

• インポートされたricloudモジュールのtoken属性を介して。

import ricloud

ricloud.token = '<your key_token>'

• 次の内容でホームディレクトリに.ricloud.iniファイルを作成します。

[api]
token = <you key_token>

詳細については、 .ricloud.iniファイルのリファレンスを参照してください。

使用法

クライアントは、各APIリソースのクラスとそれらと対話するための一連のメソッドを公開します。

>>> import ricloud

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

>>> print(org.name)
My Organisation

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

>>> print(org.name)
Changed Organisation

サンプル実装

クライアントには、いくつかの一般的な対話用のサンプル実装が含まれています。

これらは、 samplesコマンドを介してアクセスできます。

iCloud

iCloudサンプル実装は、コマンドラインを介してiCloudアカウントからデータを取得する簡単な方法を提供します。

リレーの再インキュベーション

Reincubate Relayサービスのサンプルには、セッションの作成、サブスクリプションのセットアップ、およびポーリングの手動トリガーに必要な一連のコマンドが実装されています。

Webhookエンドポイント

クライアントには、着信APIイベント通知をリッスンし、コンソールに情報を出力する単純なwebhookエンドポイント実装が含まれています。

ローカルエンドポイントを安全にインターネットに公開するには、 ngrokなどのユーティリティを使用することをお勧めします。デフォルトでは、webhookエンドポイントはマシンのポート8080にバインドされています。

ngrok http -bind-tls=true 8080

Forwarding行でhttps://abcd1234.ngrok.ioように、公開されているngrokエンドポイントのアドレスを確認できhttps://abcd1234.ngrok.io 。

その後、 ricloud event listenコマンドを実行して、リスナーを起動できます。クライアントが正しく構成されている場合、コマンドで指定されたURLを使用してwebhook構成を自動的に作成し、現在使用中のキーのデフォルトwebhook構成として設定します。

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

.ricloud.iniファイル参照

セクション： api

token

APIのエンドポイントに対する認証に使用されるトークン。

url

APIの基本URL。デフォルト： https://ricloud-api.reincubate.com : https://ricloud-api.reincubate.com

max_retries

サーバーエラーまたは接続エラーが原因で失敗した場合に、要求を再試行する回数。デフォルト： 3

await_for

指定した値でRicloud-Awaitヘッダーを追加して、 Ricloud-Await 応答メカニズムを有効にします。デフォルト： 0

セクション： webhooks

secret

着信イベント通知ペイロードを検証するときに使用するwebhook構成シークレット。 ricloud event listenコマンドに--webhook-urlオプションを使用すると、これは自動的に設定されます。

delta

イベントが送信されたときと受信されたときの間の許容される差異（秒単位）。デフォルト： 600

セクション： logging

log_level

セクション： samples

output_directory

サンプルスクリプトの一部としてダウンロードされたすべての結果のデフォルトの出力ディレクトリ。ディレクトリパスが相対パスの場合、現在の作業ディレクトリを基準にして作成されます。

user_identifier

サンプルスクリプトを実行すると、クライアントはUserリソースを作成します。このユーザーの識別子のデフォルト値はricloud-pyですが、このオプションで簡単にカスタマイズできます。

これは、例えば、同じ組織内の異なる開発者間で使用法を区別するのに役立ちます。

[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