プロトコル

更新しました

非同期処理

APIはすべてのポーリングに非同期処理を利用します。これには、iCloudなどの外部サービスとのやり取りも含まれます。これらは、必要な処理量によっては完了までに数秒から数分かかることがあるためです。

多くの標準的なリソースの相互作用は、APIリファレンスドキュメントで概説されている非同期の「副作用」を引き起こす可能性があります。これらは通常、妥当性検査またはその他のユーティリティー機能を実行するためのものです。

APIの非同期基盤は、API内からトリガーされる定期的なポーリングのためのインターフェースを単純化するのにも役立ちます。つまり、イベントと結果の取得は、APIと直接やり取りする場合でも、または定期的な投票を通じてやり取りする場合でも同じです。

応答待ち

APIは、ポーリングの必要性を最小限に抑え、エンドユーザーの合計応答時間を短縮するために、長期間有効な要求を介して非同期タスクの完了を待機することをサポートします。この機能を有効にするには、 Ricloud-Await HTTPヘッダーを希望するタイムアウト値でリクエストに追加します。現在の最大タイムアウト値は10秒です。

Ricloud-Await: 3

この機能は、次のエンドポイントでサポートされています。

暗号化された公開

APIによって公開されたすべての結果は、組織全体の公開RSAキーを使用して暗号化できます。

属性タイプ

日時属性は、常にISO 8601仕様に従ってフォーマットされます。 APIはUTCタイムゾーンを持つすべての日時属性を返します。したがって、予想されるフォーマットは"2018-08-22T10:25:05Z"です。

ページネーション

APIは、カーソルベースのページ区切りを利用します。すべてのリスト型呼び出しは追加のパラメーターを取ります。

  • 返されるアイテムの最大数を指定するためのlimit 。デフォルト値は10、最大値は1000です。
  • after_idを指定して、リストを開始するIDを指定します。
  • リストを停止するリソースIDを指定するbefore_id

リスト応答には、 data属性で返されたリソースが含まれています。また、ヘルパー属性has_moreも含まれています。これは、制限のために含まれていなかったより多くのリソースをリストすることができるかどうかを示します。

レート制限

APIへのリクエストは、標準のレート制限または機内リクエスト制限のいずれかによって制限できます。前者は大規模なAPIリソースの悪用を最小限に抑えるために使用され、後者は個々のリソースインスタンスを保護するために使用されます。

レート制限の例:単一の組織からのAPIへのリクエスト数は、1時間あたり10,000リクエストに制限されています。これにより、悪意のあるまたは偶発的なトラフィックの急増から保護することができます。

実行中の制限の例 :別のタスクが既に処理中の場合、ソースリソースのインスタンスはそれに対して作成されたタスクを持つことができません。これにより、セッションの整合性が維持され、外部サービスへのトラフィックが最小限に抑えられます。

バージョニング

APIのメジャーリリースは主にセマンティックバージョニングスキーム(つまりv1v2v3 )に従いますが、APIのv3バージョン内で行われた変更はカレンダーバージョニングスキーム(すなわち2018-11-06に従ってバージョン管理されます。バージョンは組織に合わせてグローバルに設定することも、 Ricloud-Versionヘッダーを介して要求ごとに指定することもできます。

削除可能なリソース

ほとんどのリソースは削除不可能です。つまり、所有している組織によってのみ非アクティブ化されるか、API管理者によってブロックされるだけです。

どのように我々は助けることができます?

サポートチームがお手伝いします!

営業時間は月曜日から金曜日の午前9時から午後5時(GMT)です。 時間は現在 3:30 PM GMTです。

1営業日以内に、お返事を差し上げます。メールアドレスはこちら。

サポートセクションに移動 › エンタープライズチームに連絡する ›
私たちの素晴らしいサポートチーム

© 2008 - 2019 Reincubate Ltd. 無断複写・転載を禁じます。 イングランドとウェールズに登録 #5189175, VAT GB151788978. Reincubate®は登録商標です。 プライバシーと利用規約. マルチファクタ認証をお勧めします。 ロンドンで愛と建てられた。