概要

これは、Reincubateのricloud APIのドキュメントです。 APIを使用すると、ユーザーは、Reincubate Relayアプリを介して、AppleのiCloudおよびローカルのiTunesバックアップにある自分のデータにアクセスできます。

製品情報については、 ricloud API製品ページを参照してください 。

主な概念

リソース

APIは一連のリソースに編成されています。クライアントは、これらを作成、取得、更新、破棄（CRUD）して、APIの操作を構成、トリガー、および監視できます。詳細については、 APIリソースリファレンスをご覧ください。

非同期処理

APIは、サードパーティのサービスとデータ処理に対するセッションの設定を非同期操作に依存しています。これにより、責任を持って外部サービスと対話しながら、大量のデータ要求を管理することができます。また、応答時間の変動やサードパーティからのサービスの低下に対応するための柔軟性が高まります。

ストレージバケットの公開

APIから要求されたデータは、Google Cloud StorageまたはAmazon S3のクライアントのバケットに直接公開されます。これにより、データ配信の拡張に関連する問題を最小限に抑えることができます。また、公開がボトルネックになる可能性が低いため、データ検索を高速化できます。

ウェブフック通知

非同期操作の完了通知はWebhookを介して処理されます。これにより、イベントは標準のHTTPリクエストを介してクライアントのサーバーに送信されます。これらのイベントには、クライアントのバケット内で要求されたデータを見つける場所に関する情報が含まれているため、クライアントはいつどのように使用するかを決定できます。

主な用語

入門セクションに入る前に、全体を通して使用されることになる少数の用語と概念に精通していることは有用です。

サービス

サービスは、APIを通じて利用可能なデータソースのコレクションを記述します。これには、iCloudなどのサードパーティサービス、またはリレーなどのReincubate製品が含まれます 。

サービスが異なれば、API上の特定のリソースに対するさまざまな要件があり、またAPIオブジェクトの全体的なライフサイクルも変わります。たとえば、iCloudサービスのセッションを作成するために必要なペイロードは、 asrelayサービスで必要なペイロードとは異なります。

ソース

これらは、サービス内の特定のデータソースです。 iCloudアカウントはiCloudサービスの主要なソースですが、Reincubate RelayアプリインスタンスはReincubate Relayサービスの主要なソースです。

ユーザー

ユーザーは、データを要求しているエンドユーザーを表します。多くの場合、これはアプリケーションのユーザーになります。

セッション

セッションは特定のソースへのアクセスを表し、APIを介してソースから情報やデータを取得するために必要です。

セッションの作成は、iCloudアカウントへの「ログイン」、またはReincubate Relayアプリインスタンスとの「ペアリング」に相当します。

APIはセッション初期化プロセスを非同期で実行します。つまり、セッションを作成するための呼び出しはすぐに返されますが、初期化が完了するまでセッションは使用できません。

世論調査

投票は、ユーザーがAPIを介してデータをリクエストする方法です。ポーリングを作成するには、ターゲットのソースに対するアクティブなセッションが必要です。

すべての投票は1つ以上のタスクを介して非同期的に処理され、結果は組織に設定されているクラウドストレージバケットに公開されます。

仕事

これらは、APIによって実行される基本的な作業のチャンクです。セッションが作成されると、外部サービスに対する初期化を実行するためのタスクも作成されます。投票が作成されると、必要な作業を実行するために少なくとも1つのタスクが作成されます。

結果

結果は、クライアントのストレージバケットに公開されたデータまたはファイルへの参照です。