RESTful API v2
ウィーバー (Weaver)
認証、エコシステム データの受信、エラー処理、データベース テーブルの操作、ページおよびコントラクトの実行を含む、提供されるすべての機能は、
IBAX Blockchain PlatformのREST APIが利用可能です。
REST API を使用すると、開発者は Weaver を使用せずにプラットフォームの機能にアクセスできます。
API コマンド呼び出しは、/api/v2/command/[param]
をアドレス指定することによって実行されます。ここで、command
はコマンド名で、param
は追加のパラメータです。 リクエストパラメータは、
Content-Type: x-www-form-urlencoded
フォーマットで送信されます。 サーバーの応答結果は JSON 形式です。
エラー応答処理
リクエストの実行が成功した場合にステータスを返す
「200」。 エラーが発生した場合は、エラーステータスに加えて、次のフィールドを含む JSON オブジェクトが返されます。
エラー
エラー識別子。
メッセージ
エラー テキスト メッセージ。
パラメータ
エラー メッセージに配置できる追加パラメータの配列。
応答例
Error list
E_CONTRACT
%s
コントラクトが存在しません
E_DBNIL
E_DELETEDKEY
E_ECOSYSTEM
E_EMPTYPUBLIC
E_KEYNOTFOUND
E_HASHWRONG
E_HASHNOTFOUND
E_HEAVYPAGE
E_INVALIDWALLET
E_LIMITTXSIZE
E_NOTFOUND
E_PARAMNOTFOUND
E_PERMISSION
E_QUERY
E_RECOVERED
E_SERVER
E_SIGNATURE
E_STATELOGIN
E_TABLENOTFOUND
E_TOKENEXPIRED
E_UNAUTHORIZED
E_UNKNOWNUID
E_UPDATING
E_STOPPING
E_NOTIMPLEMENTED
E_BANNED
E_CHECKROLE
CLB ノードが使用できないインターフェース要求。
- metrics
- txinfo
- txinfoMultiple
- appparam
- appparams
- appcontent
- history
- balance
- block
- maxblockid
- blocks
- detailed_blocks
- ecosystemparams
- systemparams
- ecosystems
- ecosystemparam
- ecosystemname
- walletHistory
- tx_record
リクエストの種類
制服の使用
- application/x-www-form-urlencoded
Authentication Interface
JWT token (opens new window)
認証に使用されます。 JWT トークンは、受信後に各リクエスト ヘッダーに配置する必要があります: Authorization: Bearer TOKEN_HERE
。
getuid
GET/ は一意の値を返し、秘密キーで署名してから、
login コマンドは、それをサーバーに送り返します。
login を呼び出すときに Authorization に渡す必要がある一時的な JWT トークンを生成します。
請求
応答
uid
署名番号。
token
ログイン時に渡される一時トークン。
一時トークンのライフサイクルは 5 秒です。
network_id
サーバー識別子。
cryptoer
楕円曲線アルゴリズム。
hasher
ハッシュアルゴリズム。
応答例1
認証が不要な場合(リクエストに Authorization が含まれている場合)には、以下のメッセージが返されます:
expire
有効期限です。
ecosystem
エコシステム* > エコシステムID。
key_id
アカウントアドレス。
address
ウォレットアドレス XXXX-XXXX-.... -XXXX
です。
network_id
サーバーの識別子です。
応答例2
エラー応答
E_SERVER
login
POST/ User authentication.
getuidを最初に呼び出す必要があります。
getuidの一時的なJWTトークンは、リクエストヘッダで渡す必要があります。
リクエストに成功した場合、レスポンスで受け取ったトークンは Authorization に含まれます。
請求
ecosystem
エコシステムID。
指定しない場合、デフォルトで最初のエコシステム ID が使用されます。
expire
JWT トークンのライフサイクル (秒単位)、デフォルトは 28800 です。
pubkey
16 進数のアカウント公開キー。
key_id
アカウントアドレス XXXX-... -XXXX
。
公開キーがすでにブロックチェーンに保存されている場合は、このパラメータを使用します。 pubkey と一緒に使用することはできません
パラメータが併用されます。
signature
getuid 経由で受信した uid 署名。
応答
token
JWT トークン。
ecosystem_id
エコシステムID。
key_id
アカウントアドレスID。
account
ウォレットアドレス XXXX-XXXX-..... -XXXX
。
notify_key
通知 ID。
isnode
アカウントアドレスがノードの所有者であるかどうか。 値: true,false
.
isowner
アカウントアドレスがエコシステムの作成者であるかどうか。 値: true,false
.
clb
ログインしたエコシステムが CLB かどうか。 値: true,false
.
roles
Omitempty
ロールリスト: [{Role ID,Role Name}]
.
応答例
エラー応答
E_SERVER, E_UNKNOWNUID, E_SIGNATURE, E_STATELOGIN, E_EMPTYPUBLIC
Server Side command interface
version
GET/ 現在のサーバーのバージョンを返します。
このリクエストにはログイン認証は必要ありません。
請求
応答例
Data Request Function Interface
balance
GET/ 現在のエコシステムのアカウント アドレスの残高をリクエストします。
このリクエストにはログイン認証は必要ありません。
請求
応答
amount
The minimum unit of contract account balance.
money
Account balance.
total
Account balance.
utxo
UTXO account balance.
応答例
エラー応答
E_SERVER, E_INVALIDWALLET
blocks
GET/ 各ブロック内のトランザクションに関連する追加情報を含むリストを返します。
このリクエストにはログイン認証は必要ありません。
請求
応答
Block height
ブロック内のトランザクションのリストと各トランザクションの追加情報。
取引ハッシュ。
契約名。
コントラクトパラメータの配列。
最初のブロックの場合、トランザクションに署名した最初のブロックのアカウント アドレスです。
他のすべてのブロックの場合、トランザクションに署名したアカウントのアドレスです。
応答例
エラー応答
E_SERVER, E_NOTFOUND
detailed_blocks
GET/ 各ブロック内のトランザクションに関する詳細な追加情報を含むリストを返します。
このリクエストにはログイン認証は必要ありません。
請求
応答
Block height
The block height. blockhead
ブロックヘッダには次のフィールドが含まれています。 block_id
ブロックの高さ。 time
ブロックの生成タイムスタンプ。 key_id
ブロックに署名するアカウントのアドレス。 node_position
ブロックを生成したノードの位置(名誉ノードリスト内)。 version
ブロックの構造バージョン。 hash
ブロックのハッシュ。 node_position
ブロックを生成したノードの位置(名誉ノードリスト内)。 key_id
ブロックに署名したアカウントのアドレス。 - time ブロックの生成タイムスタンプ。
- tx_count ブロック内のトランザクション数。
- size ブロックのサイズ。
- rollback_hash ブロックのロールバックハッシュ。
- merkle_root ブロックのマークルツリー。
- bin_data ブロックヘッダ、ブロック内のすべてのトランザクション、前のブロックのハッシュ、およびブロックを生成したノードの秘密鍵のシリアル化。
- transactions ブロック内のトランザクションのリストと各トランザクションに関する追加情報。
- hash トランザクションのハッシュ。
- contract_name コントラクトの名前。
- params コントラクトのパラメータ。
- key_id このトランザクションに署名するアカウントのアドレス。
- time トランザクションの生成タイムスタンプ。
- type トランザクションのタイプ。
- size トランザクションのサイズ。
応答例
エラー応答
E_SERVER, E_NOTFOUND
/data/{id}/data/{hash}
GET/ 指定されたハッシュがバイナリウォッチ、フィールド、およびレコード内のデータと一致する場合、このリクエストはデータを返します。一致しない場合はエラーを返します。
このリクエストではログインの認証は必要ありません。
請求
id
レコードのID。
hash
リクエストデータのハッシュ。
応答
バイナリデータ
応答例
エラー応答
E_SERVER, E_NOTFOUND, E_HASHWRONG
/data/{table}/id/{column}/{hash}
GET/ 指定したハッシュが指定されたテーブル、フィールド、およびレコードのデータと一致する場合、リクエストはデータを返します。一致しない場合はエラーを返します。
このリクエストではログインの認証は必要ありません。
請求
table
データテーブルの名前。
id
レコードID。
column
データテーブルの名前(1つのみ)。
hash
ハッシュリクエストデータ。
応答
バイナリデータ
応答例
エラー応答
E_SERVER, E_NOTFOUND, E_HASHWRONG
keyinfo
GET/ 指定したアドレスに登録された役割を持つエコシステムのリストを返します。
このリクエストではログイン認証は必要ありません。
請求
address
Address identifier, you can specify int64, uint64, xxxx -...-xxxx
.
This request is query in all ecosystems.
応答
ecosystem
エコシステムのIDです。
name
エコシステムの名前です。
roles
id と name フィールドを持つ役割のリストです。
応答例
エラー応答
E_SERVER, E_INVALIDWALLET
walletHistory
GET/ 現在のアカウントのトランザクション履歴レコードを返します。IDによって検索されます。
Authorization
請求
searchType
検索タイプ(収入:Income, 支出:Outcom, 全て:All, デフォルト:All)。
page
Omitempty
ページ番号を指定します。デフォルトは最初のページで、最小値は1です。
limit
Omitempty
取得するトランザクション数を指定します。デフォルトは20件で、最小値は1、最大値は500です。
応答
応答例
エラー応答
E_SERVER
listWhere/{name}
GET/ 現在のエコシステムで指定されているデータ テーブルのエントリに戻ります。 返される列を指定できます。
Authorization
請求
取得するレコードの最大数。デフォルトは25。
ページネーションのオフセット。デフォルトは0。
ソート方法。デフォルトは id ASC
。
取得する列のリストをカンマ区切りで指定します。指定しない場合、すべての列が返されます。ただし、id
列は常に返されます。
クエリの条件を指定します。
例: id > 2 かつ name = "john" をクエリしたい場合
where: {"id": {"$gt": 2}, "name": {"$eq": "john"}}
のように使用します。
詳細は [DBFind](../ topics/script.md#dbfind) の where 構文を参照してください。
応答
count
エントリーの総数。
list
配列内の各要素には以下のパラメータが含まれます:
id
ストライプID.
...
データテーブルの他の列
応答例
エラー応答
E_SERVER,E_TABLENOTFOUND
nodelistWhere/{name}
GET/ 指定したデータテーブルに戻ります。 返される列を指定できます。 データテーブルの型は BYTEA です。 16 進数のエンコード処理を行います。
Authorization
請求
name
データテーブル名。
limit
Omitempty
取得するエントリー数。デフォルトは25。
offset
Omitempty
取得するエントリーのオフセット。デフォルトは0。
order
Omitempty
ソート方法。デフォルトは id ASC
。
columns
Omitempty
取得するカラムのリスト。カンマで区切って指定します。指定しない場合、すべてのカラムが返されます。ただし、id
カラムは常に返されます。
where
Omitempty
クエリの条件
例: id> 2 かつ name = john をクエリしたい場合
以下のように使用します: where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}
詳細については、[DBFind](../ topics/script.md#dbfind) の where 構文を参照してください。
応答
count
エントリーの総数。
list
配列内の各要素には以下のパラメータが含まれます:
id
ストライプのID。
...
データテーブルの他のカラム
応答例
エラー応答
E_SERVER,E_TABLENOTFOUND
Get Metrics Interface
metrics/keys
GET/ エコシステム 1 アカウントのアドレスの数を返します。
請求
応答例
metrics/blocks
GET/ ブロック数を返します。
請求
応答例
metrics/transactions
GET/ トランザクションの合計数を返します。
請求
応答例
metrics/ecosystems
GET/ エコシステムの数を返します。
請求
応答例
metrics/honornodes
GET/ オナーノードの数を返します。
このリクエストにはログイン認証は必要ありません。
応答例
Ecosystem Interface
ecosystemname
GET/ エコシステムの名前をその識別子で返します。
このリクエストにはログイン認証は必要ありません。
応答例
エラー応答
E_PARAMNOTFOUND
appparams/{appid}
Authorization
GET/ 現在または指定されたエコシステム内のアプリケーション パラメーターのリストを返します。
請求
appid
アプリケーションのID。
ecosystem
エコシステムのID。指定しない場合、現在のエコシステムのパラメータが返されます。
names
取得するパラメータのリスト。
カンマ区切りでパラメータ名を指定できます。例: /api/v2/appparams/1?names=name,mypar
。
応答
list
配列の各要素には、以下のパラメータが含まれます。
- name:パラメータの名前。
- value:パラメータの値。
- conditions:パラメータの権限を変更します。
応答例
エラー応答
E_ECOSYSTEM
appparam/{appid}/{name}
Authorization
GET/ 現在または指定されたエコシステム内のアプリケーション {name} のパラメータ {appid} を返します
に関連する情報は、
請求
appid
アプリケーションID。
name
リクエストされたパラメータの名前。
ecosystem
Omitempty
エコシステムのID(省略可能なパラメータ)。
デフォルトでは現在のエコシステムが返されます。
応答
id
パラメータのID。
name
パラメータの名前。
value
パラメータの値。
conditions
パラメータの変更権限。
応答例
エラー応答
E_ECOSYSTEM, E_PARAMNOTFOUND
ecosystemparams
Authorization
GET/ エコシステムパラメータのリストを返します。
請求
ecosystem
Omitempty
Ecosystem IDが指定されていない場合、現在のエコシステムIDが返されます。
names
Omitempty
カンマで区切られた要求パラメータのリストです。
例: /api/v2/ecosystemparams/?names=name,currency,logo
。
応答
list
各要素は、次のパラメータを含んでいます。
パラメータの名前。
パラメータの値。
パラメータの変更権限。
応答例
エラー応答
E_ECOSYSTEM
ecosystemparam/{name}
Authorization
GET/ 現在または指定されたエコシステムのパラメータ {name} に関する情報を返します。
請求
name
要求されたパラメータの名前。
ecosystem
Omitempty
デフォルトでは、現在のエコシステム ID が返されます。
応答
各要素は、次のパラメータを含んでいます。
パラメータの名前。
パラメータの値。
パラメータの変更権限。
応答例
エラー応答
E_ECOSYSTEM
tables/[?limit=... &offset=... ]
Authorization
GET/ 現在のエコシステムのデータ テーブルのリストを返します。 オフセットとエントリ数を設定できます。
請求
応答
count
データテーブル内のエントリの総数。
list
配列の各要素には、次のパラメータが含まれています。
プレフィックスなしのデータテーブル名。
データテーブル内のエントリ数。
応答例
table/{name}
Authorization
GET/ 現在のエコシステム リクエスト データ テーブルに関する情報を返します。
請求
name
データテーブル名。
insert
新しいエントリを追加する権限。
new_column
フィールド追加の権限。
update
エントリを変更する権限。
columns
フィールドに関連する情報の配列。
フィールド名。
フィールドのデータ型。
フィールド値の変更権限。
list/{name}[?limit=... &offset=... &columns=... ]
Authorization
GET/ 現在のエコシステム内の指定されたデータ テーブル エントリのリストを返します。 オフセットとエントリ数を設定できます。
請求
name
データテーブル名。
limit
Omitempty
エントリ数、デフォルトは25エントリ。
offset
Omitempty
オフセット、デフォルトは0。
columns
Omitempty
要求されたカラムのカンマ区切りリスト。指定されていない場合、すべてのカラムが返されます。idカラムは常に返されます。
応答
count
エントリの総数。
list
配列の各要素には、次のパラメータが含まれています。
エントリのID。
応答例
sections[?limit=... &offset=... &lang=]
Authorization
GET/ 現在のエコシステムの セクション を返します
テーブルエントリのリストでは、オフセットとエントリ数を設定できます。
role_access の場合
フィールドにロールのリストが含まれており、現在のロールが含まれていない場合、レコードは返されません。 タイトル
フィールドのデータは、リクエスト ヘッダーの Accept-Language 言語リソースに置き換えられます。
請求
limit
Omitempty
エントリの数。デフォルトは25エントリ。
offset
Omitempty
オフセット。デフォルトは0。
lang
Omitempty
このフィールドは、マルチ言語リソースコードまたはローカライゼーションを指定します。例えば、en, jaです。指定したマルチ言語リソースが見つからない場合、例えばen-USの場合は、
enのマルチ言語リソースグループを検索します。
応答
count
sections テーブルのエントリーの総数。
list
配列の各要素には、アクションテーブルのすべての列に関する情報が含まれています。
応答例
エラー応答
E_TABLENOTFOUND
row/{name}/{id}[?columns=]
Authorization
GET/ 現在のエコシステム内の指定されたデータ テーブルのエントリを返します。 返される列を指定できます。
請求
name
データテーブル名。
id
エントリーのID。
columns
Omitempty
要求された列のカンマ区切りリスト。指定されていない場合、すべての列が返されます。ID列は常に返されます。
応答
value
受信した列の値の配列です。
エントリーのIDです。
応答例
エラー応答
E_NOTFOUND
row/{name}/{column}/{id}
[Authorization] (#authorization)
GET/ 現在のエコシステムで指定されているデータ テーブルのエントリに戻ります。 返される列を指定できます。
請求
応答
Value
受信カラムの値の配列です。
ID
ストライプIDです。
その他の要求カラムのシーケンス
応答例
エラー応答
E_NOTFOUND
systemparams
Authorization
GET/ プラットフォーム パラメータのリストを返します。
請求
応答
list
配列の各要素は以下のパラメータを含んでいます。
name
パラメータ名です。
value
パラメータの値です。
conditions
パラメータの権限を変更します。
応答例
エラー応答
E_PARAMNOTFOUND
history/{name}/{id}
Authorization
GET/ 現在のエコシステム内の指定されたデータ テーブル内のエントリの変更レコードを返します。
請求
name
データテーブルの名前です。
id
エントリーのIDです。
応答
配列の各要素には、要求されたエントリの変更レコードが含まれます。
応答例
Authorization
GET/ 指定されたデータ テーブル (ページ、メニュー、またはスニペット) name 内の現在のエコシステムを返します
フィールドのエントリ。
請求
name
テーブル内のエントリの名前を指定します。
応答
id
エントリーID。
name
エントリー名。
other
テーブルの他の列。
応答例
エラー応答
E_QUERY, E_NOTFOUND
Contract Function Interface
contracts[?limit=... &offset=... ]
Authorization
GET/ 現在のエコシステム内のコントラクトのリストを返します。オフセットとエントリ数を設定できます。
請求
応答
count
エントリーの総数です。
list
配列の各要素には、以下のパラメータが含まれています。
コントラクトのIDです。
コントラクトの名前です。
コントラクトの内容です。
コントラクトが紐づいているアカウントのアドレスです。
コントラクトに紐づいているウォレットアドレス XXXX-...-XXXX
です。
コントラクトが所属しているエコシステムのIDです。
コントラクトが所属しているアプリケーションのIDです。
コントラクトの権限を変更します。
コントラクト料金支払いに使用されるパスが所属するエコシステムのIDです。
応答例
contract/{name}
Authorization
GET/ 指定されたコントラクトに関する情報を返します。 デフォルトでは、現在のエコシステムでコントラクトをクエリします。
請求
応答
id
コントラクトのVM内のIDです。
name
エコシステムID @1MainCondition
を持つコントラクト名です。
state
コントラクトのエコシステムIDです。
walletid
コントラクトが紐づいているアカウントのアドレスです。
tokenid
コントラクトの支払いに使用されるパスのエコシステムIDです。
address
コントラクトに紐づいているウォレットアドレス XXXX-...-XXXX
です。
tableid
コントラクトが存在する contracts テーブル内のエントリーのIDです。
fields
配列には、コントラクトの data セクションの各パラメータの構造情報が含まれています。
パラメータ名です。
パラメータのタイプです。
パラメータのオプションです。 `true` はオプションパラメータを示し、`false` は必須パラメータを示します。
応答例
エラー応答
E_CONTRACT
sendTX
Authorization
POST/
パラメータでトランザクションを受け取り、それらをトランザクション キューに追加し、リクエストが正常に実行された場合はトランザクション ハッシュを返します。 このハッシュはブロック内の対応するトランザクションを生成し、エラー応答の場合はエラー テキスト メッセージに含まれます。
請求
tx_key
トランザクションの内容。このパラメータは任意の名前を指定でき、複数のトランザクションの受信をサポートします。
応答
hashes
トランザクションのハッシュの配列です。
トランザクション1のハッシュです。
トランザクションNのハッシュです。
応答例
エラー応答
E_LIMITTXSIZE,E_BANNED
txstatus
Authorization
POST/
指定されたトランザクション ハッシュのブロック ID とエラー メッセージを返します。 ブロック ID とエラー テキスト メッセージの戻り値が null の場合、トランザクションはまだブロックに含まれていません。
請求
data
トランザクション ハッシュの JSON リスト。
応答
results
トランザクションのハッシュをキーとし、データ辞書内のトランザクション詳細を値として使用します。
hash
トランザクションのハッシュです。
トランザクションの実行が成功した場合、ブロックのIDが返されます。トランザクションの実行が失敗した場合、[0]{.title-ref} のブロックIDが返されます。
トランザクションの結果を $result 変数を通じて返します。
トランザクションの実行に失敗した場合、エラーテキストメッセージが返されます。
応答例
エラー応答
E_HASHWRONG, E_HASHNOTFOUND
txinfo/{hash}
このリクエストにはログイン認証は必要ありません。
GET/
ブロック ID や確認の数など、指定されたハッシュのトランザクションに関する情報を返します。 オプションのパラメーターが指定されている場合は、コントラクト名とそれに関連するパラメーターも返します。
請求
hash
トランザクションのハッシュ。
contractinfo
Omitempty
契約詳細パラメータ識別子。このトランザクションに関連する契約詳細を取得するには、contractinfo=1
を指定します。
応答
blockid
値が「0」の場合、そのハッシュに対するトランザクションは見つかりませんでした。
confirm
このブロック blockid の承認数です。
data
Omitempty
contentinfo=1
が指定されている場合、このパラメータには契約の詳細が返されます。
応答例
エラー応答
E_HASHWRONG
txinfoMultiple
このリクエストにはログイン認証は必要ありません。
GET/
指定されたハッシュのトランザクション関連情報を返します。
請求
data
hashes
トランザクションハッシュのリストです。
contractinfo
Omitempty
契約の詳細に関連するこのトランザクションの契約詳細パラメーター識別子を指定するには、contractinfo=1
を指定します。
応答
results
トランザクションハッシュがデータ辞書のキーとして使用され、トランザクションの詳細が値として使用されます。
hash
トランザクションハッシュ。
blockid
そのハッシュに対してトランザクションが見つからない場合は、値が 0
です。
confirm
このブロック blockid の承認数。
data
contentinfo=1
が指定されている場合、契約の詳細がこのパラメーターに返されます。
応答例
エラー応答
E_HASHWRONG
/page/validators_count/{name}
このリクエストにはログイン認証は必要ありません。
GET
指定されたページで検証されるノードの数を返します。
請求
name
@ecosystem_id%%page_name%
形式のエコシステム ID を含むページ名、たとえば
@1main_page
。
エコシステム ID をお持ちでない場合は、デフォルトで最初のエコシステム ページを検索します
応答
validate_count
ページに対して検証するノードの数を指定します。
応答例
エラー応答
E_NOTFOUND, E_SERVER
Authorization
POST
テンプレート エンジンによる処理の結果である、指定されたページまたはメニュー名のコード JSON オブジェクトのツリーを返します。
請求
name
@ecosystem_id%%page_name%
形式のエコシステム ID を含むページ名またはメニュー名 (例:
@1main_page
。
エコシステム ID が含まれていない場合は、デフォルトで現在のエコシステム ページまたはメニューを検索します。
応答
応答例
エラー応答
E_NOTFOUND
content/source/{name}
Authorization
POST
指定されたページ名のコード化された JSON オブジェクトのツリーを返します。 関数の実行やデータの受信は行いません。 返された JSON オブジェクト ツリーはページ テンプレートに対応しており、ビジュアル ページ デザイナーで使用できます。 ページが見つからない場合は、404 エラーが返されます。
Request """""""
name
@ecosystem_id%%page_name%
形式のエコシステム ID を含むページ名、たとえば
@1main_page
。
エコシステム ID が含まれていない場合は、デフォルトで現在のエコ ページを検索します。
応答
tree
JSON object tree of the page.
応答例
エラー応答
E_NOTFOUND, E_SERVER
content/hash/{name}
POST
指定されたページ名の SHA256 ハッシュを返します。ページが見つからない場合は 404 エラーを返します。
このリクエストにはログイン認証は必要ありません。 他のノードにリクエストを行うときに正しいハッシュを受け取るには、以下も渡す必要があります。
ecosystem,keyID,roleID,isMobileパラメータ。 他のエコシステムからページを受信するには、エコシステム ID をページ名の前に付ける必要があります。 例: @2mypage
。
請求
name
エコシステム ID を含むページの名前。
ecosystem
エコシステムIDです。
keyID
アカウントアドレスです。
roleID
ロールIDです。
応答
応答例
エラー応答
E_NOTFOUND, E_SERVER, E_HEAVYPAGE
content
POST
template パラメータからページ コードの JSON オブジェクトの数を返します。オプションのパラメータ source が「true または 1」に指定されている場合、この JSON オブジェクト ツリーは関数を実行せず、データを受け取りません。 。 この JSON オブジェクト ツリーは、ビジュアル ページ デザイナーで使用できます。
このリクエストにはログイン認証は必要ありません。
請求
template
ページコード。
source
true or 1
が指定された場合、JSON オブジェクト ツリーは何も機能せずにデータを受け取ります。
応答
応答例
エラー応答
E_NOTFOUND, E_SERVER
maxblockid
GET/
現在のノード上の最大のブロック ID を返します。
このリクエストにはログイン認証は必要ありません。
請求
応答
max_block_id
現在のノード上の最大のブロック ID。
応答例
エラー応答
E_NOTFOUND
block/{id}
GET/
指定されたブロック ID に関する情報を返します。
このリクエストにはログイン認証は必要ありません。
請求
応答
hash
ブロックのハッシュです。
key_id
ブロックに署名したアカウントのアドレスです。
time
ブロックの生成タイムスタンプです。
tx_count
ブロック内のトランザクションの合計数です。
rollbacks_hash
ブロックのロールバックハッシュです。
node_position
ブロックのノード位置です。
応答例
エラー応答
E_NOTFOUND
avatar/{ecosystem}/{member}
GET/
member テーブル内のユーザーのアバターを返します (ログインなしで利用可能)。
請求
ecosystem
エコシステムID。
member
ユーザーのアカウントアドレス。 (xxxx-... -xxxx)
応答
リクエスト ヘッダー Content-Type は画像タイプであり、画像データは応答本文で返されます。
応答例
エラー応答
E_NOTFOUND E_SERVER
config/centrifugo
GET/
centrifugo のホストアドレスとポートを返します。
このリクエストにはログイン認証は必要ありません。
請求
応答
応答結果の形式は http://address:port
、例: http://127.0.0.1:8100
。
エラー応答
E_SERVER
updnotificator
POST/
(廃棄)
まだ送信されていないすべてのメッセージを centrifugo 通知サービスに送信します。 指定されたエコシステムとメンバーにメッセージのみを送信します。
このリクエストにはログイン認証は必要ありません。
請求
id
メンバーのアカウントアドレス。
ecosystem
エコシステムID。
応答例
Special instructions
Omitempty
フィールドにomitempty属性がある場合、それはフィールドがオプションのパラメータであることを意味します。
Authorization
Authorizationタグのあるインターフェースでログイン認証が必要なインターフェースの場合、リクエストヘッダーにAuthorizationを追加するなどします。
key = Authorization
value = "Bearer + login token"