Module: TapyrusApiClient

Defined in:

lib/tapyrus-api-client/version.rb,
lib/tapyrus-api-client.rb,
lib/tapyrus-api-client/api_error.rb,
lib/tapyrus-api-client/api_client.rb,
lib/tapyrus-api-client/api/user_api.rb,
lib/tapyrus-api-client/api/token_api.rb,
lib/tapyrus-api-client/configuration.rb,
lib/tapyrus-api-client/api/address_api.rb,
lib/tapyrus-api-client/api/tracking_api.rb,
lib/tapyrus-api-client/api/timestamp_api.rb,
lib/tapyrus-api-client/models/timestamp_type.rb,
lib/tapyrus-api-client/models/token_response.rb,
lib/tapyrus-api-client/models/tracking_trace.rb,
lib/tapyrus-api-client/models/tracking_subject.rb,
lib/tapyrus-api-client/models/tracking_response.rb,
lib/tapyrus-api-client/models/userinfo_response.rb,
lib/tapyrus-api-client/models/create_user_request.rb,
lib/tapyrus-api-client/models/get_tokens_response.rb,
lib/tapyrus-api-client/models/issue_token_request.rb,
lib/tapyrus-api-client/models/tracking_destination.rb,
lib/tapyrus-api-client/models/add_timestamp_request.rb,
lib/tapyrus-api-client/models/reissue_token_request.rb,
lib/tapyrus-api-client/models/add_timestamp_response.rb,
lib/tapyrus-api-client/models/get_addresses_response.rb,
lib/tapyrus-api-client/models/get_timestamp_response.rb,
lib/tapyrus-api-client/models/transfer_token_request.rb,
lib/tapyrus-api-client/models/purpose_address_request.rb,
lib/tapyrus-api-client/models/supply_tracking_request.rb,
lib/tapyrus-api-client/models/consume_tracking_request.rb,
lib/tapyrus-api-client/models/tracking_traces_response.rb,
lib/tapyrus-api-client/models/transport_tracking_request.rb,
lib/tapyrus-api-client/models/userinfo_response_balances.rb,
lib/tapyrus-api-client/models/tracking_subject_merkle_root.rb

Overview

#Tapyrus API

## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていきます。 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 * Tracking: トレーサビリティを目的としてたモノの移動履歴を記録 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 のエンドポイント エンドポイントは以下のフォーマットで作成されます。 `xxx.api.tapyrus.chaintope.com/api/v1` `xxx`の部分は各ユーザー固有の識別子になります。正式なURLは、ダッシュボードで確認できます。 ### API接続の準備 ダッシュボードに登録すると、chaintopeが登録情報を確認後、お客様のAPIエンドポイントを設定します。 エンドポイントが設定されるまでは、APIの機能はご利用いただけません。 #### クライアント証明書 Tapyrus APIに接続する際には、クライアント証明書が必要になります。ダッシュボードの「クライアント証明書」のメニューより、 クライアント証明書を発行してください。 発行すると秘密鍵と公開鍵の証明書を含む(en.wikipedia.org/wiki/PKCS_12)形式のファイルがダウンロードできます。 #### ユーザーの登録 ダッシュボードからAPIに接続するユーザーを作成します。Tapyrus APIではユーザー単位にウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されています。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 ダッシュボードの、「ユーザー一覧」からアクセスするユーザーを作成することができます。 ユーザーを作成すると、そのユーザー用のアクセストークンが発行されます。このアクセストークンとクライアント証明書の両方が漏洩すると、 不正アクセスが可能になるため、データの取り扱いには十分注意してください。 #### 接続確認 クライアント証明書とユーザーが作成されると、APIにアクセスできるようになります。簡単な接続確認は、curlで以下のように行なえます。 1. ダウンロードしたPKCS#12ファイルからcert.pemを生成。 `$ openssl pkcs12 -in <ダウンロードした.p12ファイルのパス> -out cert.pem -nodes -clcerts` 2. cert.pemとアクセストークンを使ってAPIへアクセス。 `$ curl -X GET -H 'Authorization: Bearer <ユーザーのアクセストークン>' "xxx.api.tapyrus.chaintope.com/api/v1/timestamps" -E cert.pem` 成功するとAPIへのアクセスが可能になっています。これらの認証情報を使って、以下に記載する各APIがご利用いただけます。

The version of the OpenAPI document: 1.1.0beta4

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

Defined Under Namespace

Classes: AddTimestampRequest, AddTimestampResponse, AddressApi, ApiClient, ApiError, Configuration, ConsumeTrackingRequest, CreateUserRequest, GetAddressesResponse, GetTimestampResponse, GetTokensResponse, IssueTokenRequest, PurposeAddressRequest, ReissueTokenRequest, SupplyTrackingRequest, TimestampApi, TimestampType, TokenApi, TokenResponse, TrackingApi, TrackingDestination, TrackingResponse, TrackingSubject, TrackingSubjectMerkleRoot, TrackingTrace, TrackingTracesResponse, TransferTokenRequest, TransportTrackingRequest, UserApi, UserinfoResponse, UserinfoResponseBalances

Constant Summary

VERSION =

'1.1.0beta4'

Class Method Summary

• .configure ⇒ Object

  Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ Object

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 59

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end