diff --git a/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md b/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md index 0b64bdfd51..6a2f7ed1af 100644 --- a/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md +++ b/content/tutorials/get-started/get-started-with-the-rippled-api.ja.md @@ -1,4 +1,4 @@ -# rippled APIの使用開始 +# XRP Ledger APIの使用開始 `rippled`サーバーに対してコマンドを実行するには、接続先のサーバーをあらかじめ把握しておく必要があります。大多数のサーバーは、外部ネットワークからの直接のAPI要求を受け入れないよう設定されています。 diff --git a/content/tutorials/get-started/get-started-with-the-rippled-api.md b/content/tutorials/get-started/get-started-with-the-rippled-api.md index 79a3769372..5559654bb6 100644 --- a/content/tutorials/get-started/get-started-with-the-rippled-api.md +++ b/content/tutorials/get-started/get-started-with-the-rippled-api.md @@ -1,8 +1,30 @@ -# Get Started with the rippled API +# Get Started with XRP Ledger APIs -Before you can run any commands against a `rippled` server, you must know which server you are connecting to. Most servers are configured not to accept API requests directly from the outside network. +The XRP Ledger's core server software is [`rippled`](the-rippled-server.html). You can jump straight into developing on the XRP Ledger by accessing the API of a `rippled` server. -Alternatively, you can [run your own local copy of `rippled`](install-rippled.html). This is required if you want to access any of the [Admin Methods](admin-rippled-methods.html). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) Additionally, to access admin functionality, you must connect from a port/IP address marked as admin in the config file. +The quickest way to dive into the API is with the [**WebSocket API Tool**](websocket-api-tool.html), or use the [XRP Ledger Explorer](https://livenet.xrpl.org/) to see watch the progress of the ledger live. + +You can also [run your own instance of `rippled`](install-rippled.html) or use a [public server](#public-servers). + +## Public Servers + +Ripple provides several public servers for the benefit of the XRP Ledger community: + +| Operator | [Network][] | JSON-RPC URL | WebSocket URL | Notes | +|:---------|:------------|:-------------|:--------------|:---------------------| +| Ripple | **Mainnet** | `https://s1.ripple.com:51234/` | `wss://s1.ripple.com/` | General purpose server cluster | +| Ripple | **Mainnet** | `https://s2.ripple.com:51234/` | `wss://s2.ripple.com/` | [Full-history server](ledger-history.html#full-history) cluster | +| Ripple | Testnet | `https://s.altnet.rippletest.net:51234/` | `wss://s.altnet.rippletest.net/` | Testnet public server | +| Ripple | Devnet | `https://s.devnet.rippletest.net:51234/` | `wss://s.devnet.rippletest.net/` | Devnet public server | + +[Network]: parallel-networks.html + +These public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. + + +## Admin Access + +To use a `rippled` server's [Admin Methods](admin-rippled-methods.html). In this case, you should use whatever IP and port you configured the server to bind. (For example, `127.0.0.1:54321`) Additionally, to access admin functionality, you must connect from a port/IP address marked as admin in the config file. The [example config file](https://github.com/ripple/rippled/blob/8429dd67e60ba360da591bfa905b58a35638fda1/cfg/rippled-example.cfg#L1050-L1073) listens for connections on the local loopback network (127.0.0.1), with JSON-RPC (HTTP) on port 5005 and WebSocket (WS) on port 6006, and treats all connected clients as admin. @@ -21,22 +43,6 @@ After you open a WebSocket to the `rippled` server, you can send commands as a [ The response comes as a JSON object. -### Public Servers - -Currently Ripple (the company) maintains a set of public WebSocket servers at: - -| URL | [Network][] | Notes | -|:--------------------------------------|:------------|:-----------------------| -| `wss://s1.ripple.com/` | Mainnet | General purpose server cluster | -| `wss://s2.ripple.com/` | Mainnet | [Full-history server](ledger-history.html#full-history) cluster | -| `wss://s.altnet.rippletest.net` | Testnet | Testnet public server | -| `wss://s.devnet.rippletest.net` | Devnet | Devnet public server | - -[Network]: parallel-networks.html - -These public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. - - ## JSON-RPC You can use any HTTP client (like [RESTED for Firefox](https://addons.mozilla.org/en-US/firefox/addon/rested/), [Postman for Chrome](https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=en) or [Online HTTP client ExtendsClass](https://extendsclass.com/rest-client-online.html)) to make JSON-RPC calls a `rippled` server. Most programming languages have a library for making HTTP requests built in. @@ -56,19 +62,6 @@ Send request body as a [JSON](https://en.wikipedia.org/wiki/JSON) object with th The response is also a JSON object. -### Public Servers - -Currently, Ripple (the company) maintains a set of public JSON-RPC servers at: - -| URL | [Network][] | Notes | -|:-----------------------------------------|:------------|:---------------------| -| `https://s1.ripple.com:51234/` | Mainnet | General purpose server cluster | -| `https://s2.ripple.com:51234/` | Mainnet | [Full-history server](ledger-history.html#full-history) cluster | -| `https://s.altnet.rippletest.net:51234/` | Testnet | Testnet public server | -| `https://s.devnet.rippletest.net:51234/` | Devnet | Devnet public server | - -These public servers are not for sustained or business use, and they may become unavailable at any time. For regular use, you should run your own `rippled` server or contract someone you trust to do so. - ## Commandline diff --git a/dactyl-config.yml b/dactyl-config.yml index f684494c7a..7bd4a8fc05 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -94,6 +94,47 @@ targets: subhead: "Want more?" sub_body: "Get updates about XRP Ledger webinars, releases, and documentation!" cta: "Sign up!" + cards_1: + learn: + head: "Learn How It Works" + about_xrp: "About XRP" + cta: "All Concepts" + read_docs: + head: "Read Documentation" + full_doc_index: "Full Doc Index" + cta: "All Docs" + explore: + head: "Explore the XRP Ledger" + blurb: "Use the XRPL Explorer to view a stream of ledger activity and see validator statuses." + cta: "Go to the Explorer" + what_is_xrpl: + head: "What is the XRP Ledger?" + body_1: "The XRP Ledger is a decentralized cryptographic ledger, powered by a network of peer-to-peer servers. It is the home of XRP, a digital asset designed to bridge the many different currencies in use worldwide." + digital_asset: + head: "The Digital Asset for Payments" + url: "xrp-ledger-overview.html#the-digital-asset-for-payments" + censorship_resistant: + head: "Censorship-Resistant Transaction Processing" + url: "xrp-ledger-overview.html#censorship-resistant-transaction-processing" + fast_algorithm: + head: "Fast, Efficient Consensus Algorithm" + url: "xrp-ledger-overview.html#fast-efficient-consensus-algorithm" + finite_xrp: + head: "Finite XRP Supply" + url: "xrp-ledger-overview.html#finite-xrp-supply" + responsible_governance: + head: "Responsible Software Governance" + url: "xrp-ledger-overview.html#responsible-software-governance" + secure_crypto: + head: "Secure, Adaptable Cryptography" + url: "xrp-ledger-overview.html#secure-adaptable-cryptography" + smart_contracts: + head: "Modern Features for Smart Contracts" + url: "xrp-ledger-overview.html#modern-features-for-smart-contracts" + decentralized_exchange: + head: "On-Ledger Decentralized Exchange" + url: "xrp-ledger-overview.html#on-ledger-decentralized-exchange" + - name: ja lang: ja @@ -102,7 +143,7 @@ targets: github_branch: master strings: blog: "ブログ" - search: "このサイトをGoogleで検索" + search: "サイトをGoogleで検索" bc_home: "ホーム" tl_banner: head: "も仕分けありませんがこのページは日本語では入手不可" #TODO: check translation @@ -121,11 +162,52 @@ targets: home: # Text from xrpl.org/index.html intro: head: "価値のインターネットをパワーする。" - body1: "XRP Ledgerは誰でもが使い得るオープンソース技術。" + body1: "XRP Ledgerは誰でもが使い得るオープンソース技術。" body2: "Use the tools and information provided here to integrate with and contribute to the open-source platform." #TODO:translate subhead: "Want more?" #TODO:translate sub_body: "Get updates about XRP Ledger webinars, releases, and documentation!" #TODO:translate cta: "Sign up!" #TODO:translate + cards_1: + learn: + head: "Learn How It Works" #TODO:translate + about_xrp: "XRPについて" + cta: "全概念" + read_docs: + head: "ドキュメントを読む" + full_doc_index: "全ドキュメント目次" + cta: "全ドキュメント" + explore: + head: "XRP Ledgerを探る" + blurb: "Use the XRPL Explorer to view a stream of ledger activity and see validator statuses." #TODO:translate + cta: "XRP Ledger エクスプローラへ" + what_is_xrpl: + head: "XRP Ledgerとは何？" + body_1: "XRP Ledgerは、ピアツーピア・サーバーのネットワーク機能を備えた分散型の暗号台帳です。XRP LedgerはXRPの土台となるものであり、世界中で使用されている様々な通貨の橋渡しをするために設計されたデジタル資産です。" + digital_asset: + head: "決済のためのデジタル資産" + url: "xrp-ledger-overview.html#決済のためのデジタル資産" + censorship_resistant: + head: "耐検閲性のある取引処理" + url: "xrp-ledger-overview.html#耐検閲性のある取引処理" + fast_algorithm: + head: "高速で効率的なConsensusアルゴリズム" + url: "xrp-ledger-overview.html#高速で効率的なconsensusアルゴリズム" + finite_xrp: + head: "限定されたXRP供給量" + url: "xrp-ledger-overview.html#限定されたxrp供給量" + responsible_governance: + head: "責任あるソフトウェア管理" + url: "xrp-ledger-overview.html#責任あるソフトウェア管理" + secure_crypto: + head: "安全で適応性のある暗号技術" + url: "xrp-ledger-overview.html#安全で適応性のある暗号技術" + smart_contracts: + head: "スマートコントラクト用の最新機能" + url: "xrp-ledger-overview.html#スマートコントラクト用の最新機能" + decentralized_exchange: + head: "台帳上の分散型取引所" + url: "xrp-ledger-overview.html#台帳上の分散型取引所" + - name: xrp-api-only lang: en @@ -177,6 +259,14 @@ pages: blurb: Learn the "what" and "why" behind fundamental aspects of the XRP Ledger. targets: - en + + - name: 概念 + funnel: Docs + doc_type: Concepts + html: concepts.html + template: template-landing-children.html + blurb: Learn the "what" and "why" behind fundamental aspects of the XRP Ledger. #TODO:translate + targets: - ja - name: Introduction @@ -1193,9 +1283,17 @@ pages: funnel: Docs doc_type: Tutorials template: template-landing-children.html - blurb: Get step-by-step guidance to perform common tasks with the XRP Ledger. #TODO:translate + blurb: Get step-by-step guidance to perform common tasks with the XRP Ledger. targets: - en + + - name: チュートリアル + html: tutorials.html + funnel: Docs + doc_type: Tutorials + template: template-landing-children.html + blurb: Get step-by-step guidance to perform common tasks with the XRP Ledger. #TODO:translate + targets: - ja - name: Get Started @@ -1204,9 +1302,18 @@ pages: doc_type: Tutorials category: Get Started template: template-landing-children.html - blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger. #TODO:translate + blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger. targets: - en + + - name: 使用開始 + html: get-started.html + funnel: Docs + doc_type: Tutorials + category: Get Started + template: template-landing-children.html + blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger. #TODO:translate + targets: - ja - md: tutorials/get-started/get-started-with-the-rippled-api.md @@ -1214,7 +1321,8 @@ pages: funnel: Docs doc_type: Tutorials category: Get Started - blurb: Connect to the rippled API and get data about the shared ledger state. + blurb: Get started with the APIs and libraries available for interacting with the XRP Ledger. + cta_text: "Get Started" targets: - en @@ -1223,7 +1331,8 @@ pages: funnel: Docs doc_type: Tutorials category: Get Started - blurb: Connect to the rippled API and get data about the shared ledger state. #TODO:translate + blurb: Get started with the APIs and libraries available for interacting with the XRP Ledger. #TODO:translate + cta_text: "開始しよう！" targets: - ja @@ -2334,6 +2443,7 @@ pages: # References ------------------------------------------------------------------- - name: References + longer_name: API References funnel: Docs doc_type: References template: template-landing-references.html @@ -2342,6 +2452,16 @@ pages: blurb: Complete references for different interfaces to the XRP Ledger. #TODO:translate targets: - en + + - name: リファレンス + longer_name: API リファレンス + funnel: Docs + doc_type: References + template: template-landing-references.html + html: references.html + sidebar: disabled + blurb: Complete references for different interfaces to the XRP Ledger. #TODO:translate + targets: - ja # rippled API -------------------------------------------------------------- diff --git a/tool/template-home.html b/tool/template-home.html index 277b21a0d8..48a1048e00 100644 --- a/tool/template-home.html +++ b/tool/template-home.html @@ -32,68 +32,69 @@ {% set flag_n = cycler(* range(1,99)) %}
+ {% set cardpage = pages|selectattr('html', 'defined_and_equalto', 'get-started-with-the-rippled-api.html')|first %}
-

Get Started with XRP Ledger APIs

+

{{cardpage.name}}

-

Get started with the APIs and libraries available for interacting with the XRP Ledger.

+

{{cardpage.blurb}}

- Get Started + {{cardpage.cta_text}}
{{"%02d"|format(flag_n.next())}}
-

Learn How It Works

+

{{target.strings.home.cards_1.learn.head}}

- All Concepts + {{target.strings.home.cards_1.learn.cta}}
{{"%02d"|format(flag_n.next())}}
-

Read Documentation

+

{{target.strings.home.cards_1.read_docs.head}}

- All Docs + {{target.strings.home.cards_1.read_docs.cta}}
{{"%02d"|format(flag_n.next())}}
-

Explore the XRP Ledger

+

{{target.strings.home.cards_1.explore.head}}

-

Use the XRPL Explorer to view a stream of ledger activity and see validator statuses.

+

{{target.strings.home.cards_1.explore.blurb}}

- Go to the Explorer + {{target.strings.home.cards_1.explore.cta}}
{{"%02d"|format(flag_n.next())}}
@@ -121,58 +122,58 @@
-

What is the XRP Ledger?

+

{{target.strings.home.what_is_xrpl.head}}

-

The XRP Ledger is a decentralized cryptographic ledger, powered by a network of peer-to-peer servers. It is the home of XRP, a digital asset designed to bridge the many different currencies in use worldwide.

+

{{target.strings.home.what_is_xrpl.body_1}}

- +
(digital asset icon)
-

The Digital Asset for Payments

+

{{target.strings.home.what_is_xrpl.digital_asset.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(censorship resistance icon)
-

Censorship-Resistant Transaction Processing

+

{{target.strings.home.what_is_xrpl.censorship_resistant.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(consensus algorithm icon)
-

Fast, Efficient Consensus Algorithm

+

{{target.strings.home.what_is_xrpl.fast_algorithm.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(xrp supply icon)
-

Finite XRP Supply

+

{{target.strings.home.what_is_xrpl.finite_xrp.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(governance icon)
-

Responsible Software Governance

+

{{target.strings.home.what_is_xrpl.responsible_governance.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(cryptography icon)
-

Secure, Adaptable Cryptography

+

{{target.strings.home.what_is_xrpl.secure_crypto.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(smart contracts icon)
-

Modern Features for Smart Contracts

+

{{target.strings.home.what_is_xrpl.smart_contracts.head}}

{{"%02d"|format(flag_n.next())}}
 - +
(decentralized exchange icon)
-

On-Ledger Decentralized Exchange

+

{{target.strings.home.what_is_xrpl.decentralized_exchange.head}}

{{"%02d"|format(flag_n.next())}}