mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 11:45:50 +00:00
7645140477
For better URLs, the content folder has been renamed 'docs' and all other files have been moved up a level. Also, non-docs images have been moved to the static folder at the top level where they belong. Many relative paths had to be fixed to make this work.
3.4 KiB
3.4 KiB
html, parent, seo
| html | parent | seo | ||
|---|---|---|---|---|
| request-formatting.html | api-conventions.html |
|
リクエストのフォーマット
WebSocketフォーマット
rippledサーバーへのWebSocketを開いた後、以下の属性を使用して、コマンドをJSONオブジェクトとして送信できます。
- コマンド名を最上位の
"command"フィールドに指定します。 - このコマンドのすべての関連パラメーターも最上位に指定します。
- オプションで、任意の値を指定した
"id"フィールドを指定します。このリクエストへのレスポンスでは、同一の"id"フィールドを使用します。そうすることで、レスポンスが順不同で到達した場合も、どのリクエストによってどのレスポンスを得られたのかがわかります。
レスポンスはJSONオブジェクトとして返されます。
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"フィールドに指定します。 - 最上位の
"params"フィールドを指定します。このフィールドの内容は、コマンドのすべてのパラメーターが指定された1つの入れ子JSONオブジェクトのみを保持している1要素配列です。
レスポンスもJSONオブジェクトです。
コマンドライン形式
コマンドラインでは、通常の（ダッシュが先頭に付いた）コマンドラインオプションの後にコマンドを指定し、その後に一連の限定的なパラメーターをスペースで区切って指定します。スペースやその他の特殊文字が含まれている可能性のあるパラメーター値は、一重引用符で囲みます。
リクエストの例
{% tabs %}
{% tab label="WebSocket" %}
{
"id": 2,
"command": "account_info",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
}
{% /tab %}
{% tab label="JSON-RPC" %}
POST http://s1.ripple.com:51234/
{
"method": "account_info",
"params": [
{
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"strict": true,
"ledger_index": "validated"
}
]
}
{% /tab %}
{% tab label="コマンドライン" %}
rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated true
{% /tab %}
{% /tabs %}