module TapyrusApiClient

#Tapyrus API

## イントロダクションこれは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 Tapyrus ブロックチェーンについては以下の情報を参照してください。 * [Chaintope のブロックチェーンプロトコル](www.chaintope.com/chaintope-blockchain-protocol/) * [chaintope/tapyrus-core - github](github.com/chaintope/tapyrus-core) ## Tapyrus API の利用法 Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みのトークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。 ### Tapyrus API のエンドポイントエンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。利用に必要な TPC は [faucet](testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する入手した Access Token と ID Token を Tapyrus API の [createUser API](doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて認証により得たアクセストークンを使い、Tapyrus API ユーザを１つ作成する必要があります。 Tapyrus API の内部では、このユーザ１つにつき１つのウォレットが作成されます。ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.1-SNAPSHOT

#Tapyrus API

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.1-SNAPSHOT

#Tapyrus API

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.1-SNAPSHOT

Constants

VERSION

Public Class Methods

configure() { |default| ... } click to toggle source

Customize default settings for the SDK using block.

TapyrusApiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File lib/tapyrus-api-client.rb, line 48
def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end