仮想通貨サービス BitCapitalZ の日記

仮想通貨関連のブログです Ripple, Ethereum 仮想通貨2.0に注目しています

【リップル】Ripple APIs について調べてみる2 Ripple-REST API とはなにか【Ripple】

前回の【リップル】Ripple APIs について調べてみる1 gatewayd とはなにか【Ripple】 - 仮想通貨サービス BitCapitalZ の日記に続き今回は Ripple-REST API についての記事です。

Ripple-REST API についての詳しい説明は公式ドキュメントのRipple REST | Rippleにあります。ここで書かれていることの要点を本記事にまとめます。実際の使い方については 【リップル】Ripple APIs を使ってみる1 Ripple-REST API の使い方【Ripple】 - 仮想通貨サービス BitCapitalZ の日記 をご覧下さい


Ripple-REST API は Ripple ユーザーが持つウォレット(Ripple の世界では ウォレット = アカウント)に対して、送金、トラスト、通知、状態取得等の要求を外部から行うためのインタフェースです。

この Ripple-REST API へのエンドポイントは Ripple 公式が用意するものと、rippled を用いて自前で用意するものがあります。それらの違いについては別の記事で書こうと思います。 Ripple 公式の Ripple-REST API へのエンドポイントは https://api.ripple.com です。 rippled を自前で用意した場合は rippled がいるサーバーということになります。

つまり Ripple-REST APIrippled に要求を送るためのインタフェースということですね。 rippled に要求を送るには http 越しで Ripple-REST API を用いる他に WebSocket APIJSON-RPC API もあります。

Ripple-REST API は以下の APIが用意されており、これらを用いて前述の送金、トラスト、通知、状態取得等の要求を外部から行うことができます。

Accounts
Generate Wallet – GET /v1/wallet/new
Get Account Balances – GET /v1/accounts/{:address}/balances
Get Account Settings – GET /v1/accounts/{:address}/settings
Update Account Settings – POST /v1/accounts/{:address}/settings
Payments
Prepare Payment – GET /v1/accounts/{:source_address}/payments/paths/{:destination_address}/{:amount}
Submit Payment – POST /v1/accounts/{:source_address}/payments
Confirm Payment – GET /v1/accounts/{:address}/payments/{:id}
Get Payment History – GET /v1/accounts/{:address}/payments
Trustlines
Get Trustlines – GET /v1/accounts/{:address}/trustlines
Grant Trustline – POST /v1/accounts/{:address}/trustlines
Notifications
Check Notifications – GET /v1/accounts/{:address}/notifications/{:id}
Status
Check Connection – GET /v1/server/connected
Get Server Status – GET /v1/server
Utilities
Retrieve Ripple Transaction – GET /v1/transactions/{:id}
Retrieve Transaction Fee – GET /v1/transaction-fee
Generate UUID – GET /v1/uuid

Ripple を始め次世代仮想通貨について議論するフォーラムを用意しています。是非こちらもご覧ください

Ripple Stellar Ethereum 等次世代仮想通貨掲示板 in BitCapitalZ

Ripple-REST API 用の ruby クライアントもありますね。

https://github.com/orzfly/ruby-ripple-rest