日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

Element ソフトウェア API の概要

寄稿者 netapp-mwallis

Element API は、 HTTPS 経由の JSON-RPC プロトコルに基づいています。JSON-RPC は、軽量な JSON データ交換形式をベースにした単純なテキストベースの RPC プロトコルです。クライアントライブラリは、すべての主要なプログラミング言語で使用できます。

API エンドポイントに対して HTTPS POST 要求経由で API 要求を行うことができます。POST 要求の本文は JSON-RPC 要求オブジェクトです。この API は、現在バッチ要求(単一 POST 内の複数の要求オブジェクト)をサポートしていません。API 要求を送信する場合は、要求のコンテンツタイプとして「 application/json-rpc 」を使用し、本文がフォームエンコードされていないことを確認する必要があります。

注記 Element Web UI は、本ドキュメントに記載された API メソッドを使用します。UI で API 処理を監視するには、 API ログを有効にします。これにより、システムに対して実行されているメソッドを確認できます。要求と応答の両方を有効にすると、実行したメソッドに対するシステムの応答を確認できます。

特に指定がないかぎり、 API 応答内のすべての日付文字列は UTC+0 形式です。

注記 ストレージクラスタの負荷が高い場合や、多数の連続した API 要求を間隔を空けずに送信した場合は、メソッドが失敗してエラー「 xDBVersionMismatch 」を返すことがあります。この場合は、メソッドの呼び出しを再試行してください。