HTTP / WebSocket API リファレンス

rippledサーバの公開APIを通じて、XRP Ledgerと通信することができます。

現在、APIにはバージョン1とバージョン2の2種類があります。 サーバは、version APIメソッドを通じてサポートされているAPIバージョンの範囲を通知します。APIリクエストで使用するバージョンを指定できます。

同じ持続的な接続で、異なるAPIリクエストで異なるAPIバージョンを使用できます。例えば、WebSocketを通じて、APIバージョン1と2をサポートするサーバに接続した場合、同じ接続からAPIバージョン2を使用してaccount_txリクエストを行い、その後、APIバージョン1を使用してもう1つのaccount_txリクエストを行うことができます。

デフォルトのAPIバージョン

以下の表は、リクエストでAPIバージョンを指定しない場合に使用されるrippled APIのバージョンを示しています。

rippledの将来のバージョンでは、破壊的な変更を導入すると、APIバージョン3が導入されます。

破壊的な変更

以下のタイプの変更は、破壊的な変更です。

• リクエストまたはレスポンスのフィールドを削除または変更する。
• リクエストまたはレスポンスのフィールドの型を変更する。
• リクエストまたはレスポンスのフィールドの意味を変更する。
• 位置パラメータの順序を変更する、または他の位置パラメータの前に新しいフィールドを追加する。
• APIメソッドを削除または変更する。
• 既存のクライアントからアクセス可能なAPI関数の動作を変更する。
• 以下のタイプの破壊的な変更は、gRPC APIにのみ適用されます。
  • protoフィールド番号を変更する。
  • 列挙型または列挙型の値を削除または変更する。
  • oneofにフィールドを追加または削除する。
  • oneofを分割またはマージする。
  • メッセージフィールドがoptional、repeated、またはrequiredであるかどうかを変更する。
  • リクエストまたはレスポンスのストリーム値を変更する。
  • パッケージまたはサービスを削除または変更する。

いずれかのリリースで破壊的な変更が導入されると、新しいAPIバージョン番号が導入されます。プレリリース、ベータ、開発バージョンは、同じAPIバージョン番号に対して破壊的な変更を導入する場合があります。

非破壊的な変更

以下のタイプの変更は、非破壊的な変更です。APIバージョン番号の変更なしに発生する可能性があります。

• リクエストまたはレスポンスに新しいフィールドを追加する（位置パラメータを除く）。
• APIメソッドを追加する。