ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-06 17:27:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

rewrote intro to be simpler and more accurate

Browse Source
This commit is contained in:
mDuo13
2014-05-22 13:24:59 -07:00
parent cb728d6e3e
commit e60a49af14
1 changed files with 5 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
intro.md
View File

@@ -12,17 +12,12 @@ If you intend to act as a gateway, you will probably want to build custom client
# Ripple APIs #
Connecting to the Ripple Network generally means connecting to a `rippled` server, sending it requests and commands, and listening to the responses. Depending on your situation, there are several different interfaces you can use to do this:
Connecting to the Ripple Network generally means connecting to a `rippled` server, sending it requests and commands, and listening to the responses. If you are building your own client, you have several options of interfaces that you can use to interact with the Ripple Network:
* The `rippled` commandline interface provides a quick way to control a local instance for testing purposes
* The Web Sockets API provides a robust, full-featured system for running commands and receiving data asynchronously from a web browser, Node.js instance, or any other environment that supports Web Sockets.
* The JSON-RPC API provides a powerful, synchronous (call-response) system for running commands and receiving data using any HTTP client; however, it does not support the asynchronous features of Web Sockets.
* The Ripple-REST API is a simpler, more intuitive method for connecting to the network; however, it requires a separate node.js server running the REST API software as a proxy between the REST-client application and the `rippled` server. This proxy can run on the same server as the rippled instance, or on the same computer as the ripple client application.
* You can set up [Ripple-REST](?p=ripple-rest-api) as a simple, intuitive, RESTful interface to `rippled`, although it does not have access to every feature of `rippled` and it requires a second Node.js server as an intermediate.
* You can connect directly using the [WebSocket API or the JSON-RPC API](?p=web-sockets-api). These APIs provide robust, full-featured access to the Ripple Network, at the cost of higher complexity.
** The `rippled` commandline can even be used as a simple JSON-RPC client application.
** The [ripple-lib Javascript client library](https://github.com/ripple/ripple-lib) makes it easier to connect to and use the WebSocket API. Client libraries for other languages are in progress.
## Choosing a `rippled` server ##
In any case (except commandline), it is your choice which `rippled` server you connect to. There are a few public servers currently available, including:
[s1.ripple.com:443]
Alternatively, you can run your own server. (If you intend to integrate your business with the Ripple Network, you will probably want to do this, so that you aren't depending on an outside source for everything.)