5.9 KiB
html, parent, seo
| html | parent | seo | ||
|---|---|---|---|---|
| request-formatting.html | api-conventions.html |
|
リクエストのフォーマット
リクエストの例
{% tabs %}
{% tab label="WebSocket" %}
{
"id": 2,
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated",
"api_version": 1
}
{% /tab %}
{% tab label="JSON-RPC" %}
POST http://s1.ripple.com:51234/
Content-Type: application/json
{
"method": "account_info",
"params": [
{
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated",
"api_version": 1
}
]
}
{% /tab %}
{% tab label="コマンドライン" %}
rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated strict
{% /tab %}
{% /tabs %}
WebSocketフォーマット
rippledサーバへのWebSocketを開いた後、以下のフィールドを使用して、コマンドをJSONオブジェクトとして送信できます。
| フィールド | 型 | 説明 |
|---|---|---|
command |
文字列 | APIメソッドの名前。 |
id |
(多種) | (省略可) リクエストを識別するための一意な値。このリクエストに対するレスポンスも同じ id フィールドを使用します。これにより、レスポンスが順番通りに返ってこない場合でも、どのリクエストがどのレスポンスを返したのかを知ることができます。 |
api_version |
数値 | (省略可) 使用するAPIのバージョン。省略時はバージョン1を使用します。詳細については、APIのバージョン管理をご覧ください。 |
| (メソッドのパラメータ) | (多種) | トップレベルのメソッドに任意のパラメータを指定します。 |
サーバからのレスポンスについてはレスポンスのフォーマットをご覧ください。
JSON-RPCフォーマット
JSON-RPCリクエストを実行するには、rippledサーバがJSON-RPC接続をリッスンしているポートおよびIPで、HTTP POSTリクエストをルートパス（/）に送信します。HTTP/1.0またはHTTP/1.1を使用できます。HTTPSを使用する場合は、TLS v1.2を使用してください。セキュリティ上の理由から、rippledではSSL v3以前を サポートしていません 。
Content-Typeヘッダ(値application/json)を常に指定してください。
複数のリクエストを実行する場合は、リクエスト間で再接続を行わずに済むように、Keep-Alivesを使用してください。
以下のフィールドを指定したリクエストボディをJSONオブジェクトとして送信します。
| フィールド | 型 | 説明 |
|---|---|---|
method |
文字列 | APIメソッドの名前。 |
params |
配列 | (省略可) このメソッドのパラメータを持つネストされたJSONオブジェクトを含む一要素の配列。メソッドがパラメータを必要としない場合は、このフィールドを省略できます。 |
params配列内のオブジェクトには以下のフィールドを含めることができます。
| フィールド | 型 | 説明 |
|---|---|---|
api_version |
数値 | (省略可) 使用するAPIのバージョン。省略時はバージョン1を使用します。詳細については、APIのバージョン管理をご覧ください。 |
| (Method Parameters) | (多種) | メソッドで利用する任意のパラメータ。 |
サーバからのレスポンスについてはレスポンスのフォーマットをご覧ください。
コマンドライン形式
APIのメソッド名は、通常の(ダッシュで始まる)コマンドラインオプションの後に、スペースで区切られた一部のパラメータを続けて指定します。スペースやその他の特殊文字を含む可能性のあるパラメータ値については、シングルクォートで囲んでください。すべてのメソッドがコマンドラインAPI構文を持っているわけではありません。詳しくは、コマンドラインの使い方をご覧ください。
コマンドラインはJSON-RPCを呼び出すため、そのレスポンスは常にJSON-RPCのレスポンスのフォーマットと一致します。
コマンドラインは常に最新のAPIバージョンを使用します。
{% admonition type="warning" name="注意" %}コマンドラインインターフェイスは管理目的でのみ使用することを意図しており、_サポートされているAPIではありません_です。新しいバージョンのrippledでは、警告なしにコマンドラインAPIに破壊的な変更が導入される可能性があります！{% /admonition %}
{% raw-partial file="/@l10n/ja/docs/_snippets/common-links.md" /%}