ElementソフトウェアAPIの概要

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メソッドを使用します。[API Log]を有効にして、UIのAPI処理を監視できます。これにより、システムで実行されているメソッドを表示できます。要求と応答の両方を有効にすると、実行したメソッドに対するシステムの返信内容を確認できます。

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

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