RESTful API v2 </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#error-response-handling" class="sidebar-link">エラー応答処理 </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#error-list" class="sidebar-link">Error list </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#request-type" class="sidebar-link">リクエストの種類 </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#authentication-interface" class="sidebar-link">Authentication Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#getuid" class="sidebar-link">getuid </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#login" class="sidebar-link">login </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#server-side-command-interface" class="sidebar-link">Server Side command interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#version" class="sidebar-link">version </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#data-request-function-interface" class="sidebar-link">Data Request Function Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#balance" class="sidebar-link">balance </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#blocks" class="sidebar-link">blocks </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#detailed-blocks" class="sidebar-link">detailed_blocks </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#data-id-data-hash" class="sidebar-link">/data/{id}/data/{hash} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#data-table-id-column-hash" class="sidebar-link">/data/{table}/id/{column}/{hash} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#keyinfo" class="sidebar-link">keyinfo </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#wallethistory" class="sidebar-link">walletHistory </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#listwhere-name" class="sidebar-link">listWhere/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#nodelistwhere-name" class="sidebar-link">nodelistWhere/{name} </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#" class="sidebar-link">Get Metrics Interface</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#metrics-keys" class="sidebar-link">metrics/keys </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#metrics-blocks" class="sidebar-link">metrics/blocks </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#metrics-transactions" class="sidebar-link">metrics/transactions </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#metrics-ecosystems" class="sidebar-link">metrics/ecosystems </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#metrics-honornodes" class="sidebar-link">metrics/honornodes </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#ecosystem-interface" class="sidebar-link">Ecosystem Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#ecosystemname" class="sidebar-link">ecosystemname </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#appparams-appid" class="sidebar-link">appparams/{appid} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#appparam-appid-name" class="sidebar-link">appparam/{appid}/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#ecosystemparams" class="sidebar-link">ecosystemparams </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#ecosystemparam-name" class="sidebar-link">ecosystemparam/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#tables-limit-offset" class="sidebar-link">tables/\[?limit=\... &offset=\... \] </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#table-name" class="sidebar-link">table/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#list-name-limit-offset-columns" class="sidebar-link">list/{name}\[?limit=\... &offset=\... &columns=\... \] </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#sections-limit-offset-lang" class="sidebar-link">sections\[?limit=\... &offset=\... &lang=\] </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#row-name-id-columns" class="sidebar-link">row/{name}/{id}\[?columns=\] </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#row-name-colorn-id" class="sidebar-link">row/{name}/{column}/{id} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#systemparams" class="sidebar-link">systemparams </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#history-name-id" class="sidebar-link">history/{name}/{id} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#interface-page-menu-snippet-name" class="sidebar-link">interface/{page|menu|snippet}/{name} </a></li></ul></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#contract-function-interface" class="sidebar-link">Contract Function Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#contracts-limit-offset" class="sidebar-link">contracts\[?limit=\... &offset=\... \] </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#contract-name" class="sidebar-link">contract/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#sendtx" class="sidebar-link">sendTX </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#txstatus" class="sidebar-link">txstatus </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#txinfo-hash" class="sidebar-link">txinfo/{hash} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#txinfomultiple" class="sidebar-link">txinfoMultiple </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#page-validators-count-name" class="sidebar-link">/page/validators_count/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#content-menu-page-name" class="sidebar-link">content/menu\|page/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#content-source-name" class="sidebar-link">content/source/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#content-hash-name" class="sidebar-link">content/hash/{name} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#content" class="sidebar-link">content </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#maxblockid" class="sidebar-link">maxblockid </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#block-id" class="sidebar-link">block/{id} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#avatar-ecosystem-member" class="sidebar-link">avatar/{ecosystem}/{member} </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#config-centrifugo" class="sidebar-link">config/centrifugo </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#updnotificator" class="sidebar-link">updnotificator </a></li><li class="sidebar-sub-header"><a href="/ja/reference/api2.html#special-instructions" class="sidebar-link">Special instructions </a></li></ul></li></ul></li><li><a href="/ja/reference/platform-parameters.html" class="sidebar-link">プラットフォームパラメータ </a></li><li><a href="/ja/reference/backend-config.html" class="sidebar-link">サーバー設定ファイル </a></li><li><a href="/ja/reference/desync_monitor.html" class="sidebar-link">同期モニタリングツール </a></li><li><a href="/ja/reference/json-rpc.html" class="sidebar-link">JSON-RPC アプリケーションプログラミングインターフェイス </a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="restful-api-v2"><a href="#restful-api-v2" class="header-anchor">#</a> RESTful API v2 </h1> <p>ウィーバー（Weaver) 認証、エコシステムデータの受信、エラー処理、データベーステーブルの操作、ページおよびコントラクトの実行を含む、提供されるすべての機能は、 IBAX Blockchain PlatformのREST APIが利用可能です。</p> <p>REST API を使用すると、開発者は Weaver を使用せずにプラットフォームの機能にアクセスできます。</p> <p>API コマンド呼び出しは、<code>/api/v2/command/[param]</code> をアドレス指定することによって実行されます。ここで、<code>command</code> はコマンド名で、<code>param</code>は追加のパラメータです。リクエストパラメータは、 <code>Content-Type: x-www-form-urlencoded</code> フォーマットで送信されます。サーバーの応答結果は JSON 形式です。</p> <ul><li><a href="#error-response-handling">Error response handling</a> <ul><li><a href="#error-list">Error list</a></li></ul></li> <li><a href="#request-type">Request Type</a></li> <li><a href="#authentication-interface">Authentication Interface</a> <ul><li><a href="#getuid">getuid</a></li> <li><a href="#login">login</a></li></ul></li> <li><a href="#server-side-command-interface">Server Side command interface</a> <ul><li><a href="#version">version</a></li></ul></li> <li><a href="#data-request-function-interface">Data Request Function Interface</a> <ul><li><a href="#balance">balance</a></li> <li><a href="#blocks">blocks</a></li> <li><a href="#detailed-blocks">detailed_blocks</a></li> <li><a href="#data-id-data-hash">/data/{id}/data/{hash}</a></li> <li><a href="#data-table-id-column-hash">/data/{table}/id/{column}/{hash}</a></li> <li><a href="#keyinfo">keyinfo</a></li> <li><a href="#wallethistory">walletHistory</a></li> <li><a href="#listwhere-name">listWhere/{name}</a></li> <li><a href="#nodelistwhere-name">nodelistWhere/{name}</a></li></ul></li> <li><a href="#get-metrics-interface">Get Metrics Interface</a> <ul><li><a href="#metrics-keys">metrics/keys</a></li> <li><a href="#metrics-blocks">metrics/blocks</a></li> <li><a href="#metrics-transactions">metrics/transactions</a></li> <li><a href="#metrics-ecosystems">metrics/ecosystems</a></li> <li><a href="#metrics-honornodes">metrics/honornodes</a></li></ul></li> <li><a href="#ecosystem-interface">Ecosystem Interface</a> <ul><li><a href="#ecosystemname">ecosystemname</a></li> <li><a href="#appparams-appid">appparams/{appID}</a></li> <li><a href="#appparam-appid-name">appparam/{appid}/{name}</a></li> <li><a href="#ecosystemparams">ecosystemparams</a></li> <li><a href="#ecosystemparam-name">ecosystemparam/{name}</a></li> <li><a href="#tables-limit-offset">tables/[?limit=... &offset=... ]</a></li> <li><a href="#table-name">table/{name}</a></li> <li><a href="#list-name-limit-offset-columns">list/{name}[?limit=... &offset=... &columns=... ]</a></li> <li><a href="#sections-limit-offset-lang">sections[?limit=... &offset=... &lang=]</a></li> <li><a href="#row-name-id-columns">row/{name}/{id}[?columns=]</a></li> <li><a href="#row-name-column-id">row/{name}/{column}/{id}</a></li> <li><a href="#systemparams">systemparams</a></li> <li><a href="#history-name-id">history/{name}/{id}</a></li> <li><a href="#interface-page-menu-snippet-name">interface/{page|menu|snippet}/{name}</a></li></ul></li> <li><a href="#contract-function-interface">Contract Function Interface</a> <ul><li><a href="#contracts-limit-offset">contracts[?limit=... &offset=... ]</a></li> <li><a href="#contract-name">contract/{name}</a></li> <li><a href="#sendtx">sendTX</a></li> <li><a href="#txstatus">txstatus</a></li> <li><a href="#txinfo-hash">txinfo/{hash}</a></li> <li><a href="#txinfomultiple">txinfoMultiple</a></li> <li><a href="#page-validators-count-name">/page/validators_count/{name}</a></li> <li><a href="#content-menu-page-name">content/menu|page/{name}</a></li> <li><a href="#content-source-name">content/source/{name}</a></li> <li><a href="#content-hash-name">content/hash/{name}</a></li> <li><a href="#content">content</a></li> <li><a href="#maxblockid">maxblockid</a></li> <li><a href="#block-id">block/{id}</a></li> <li><a href="#avatar-ecosystem-member">avatar/{ecosystem}/{member}</a></li> <li><a href="#config-centrifugo">config/centrifugo</a></li> <li><a href="#updnotificator">updnotificator</a></li></ul></li></ul> <h2 id="error-response-handling"><a href="#error-response-handling" class="header-anchor">#</a> エラー応答処理 </h2> <p>リクエストの実行が成功した場合にステータスを返す「200」。エラーが発生した場合は、エラーステータスに加えて、次のフィールドを含む JSON オブジェクトが返されます。</p> <ul><li><p><strong>エラー</strong></p> <blockquote><p>エラー識別子。</p></blockquote></li> <li><p><strong>メッセージ</strong></p> <blockquote><p>エラーテキストメッセージ。</p></blockquote></li> <li><p><strong>パラメータ</strong></p> <blockquote><p>エラーメッセージに配置できる追加パラメータの配列。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>400 (Bad request) Content-Type: application/json { "err": "E_INVALIDWALLET", "msg": "Wallet 1234-5678-9012-3444-3488 is not valid", "params": ["1234-5678-9012-3444-3488"] } </code></pre></div><h3 id="error-list"><a href="#error-list" class="header-anchor">#</a> Error list </h3> <blockquote><p><code>E_CONTRACT</code></p></blockquote> <p><code>%s</code> コントラクトが存在しません</p> <blockquote><p><code>E_DBNIL</code></p></blockquote> <div class="language- extra-class"><pre><code> データベースが空です </code></pre></div><blockquote><p><code>E_DELETEDKEY</code></p></blockquote> <div class="language- extra-class"><pre><code> アカウントアドレスが凍結されている </code></pre></div><blockquote><p><code>E_ECOSYSTEM</code></p></blockquote> <div class="language- extra-class"><pre><code> エコシステム `%d` は存在しません </code></pre></div><blockquote><p><code>E_EMPTYPUBLIC</code></p></blockquote> <div class="language- extra-class"><pre><code> 無効なアカウント公開キー </code></pre></div><blockquote><p><code>E_KEYNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code> アカウントアドレスが見つかりません </code></pre></div><blockquote><p><code>E_HASHWRONG</code></p></blockquote> <div class="language- extra-class"><pre><code> 不正なハッシュ </code></pre></div><blockquote><p><code>E_HASHNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code> ハッシュが見つかりません </code></pre></div><blockquote><p><code>E_HEAVYPAGE</code></p></blockquote> <div class="language- extra-class"><pre><code> ページの読み込みが多すぎる </code></pre></div><blockquote><p><code>E_INVALIDWALLET</code></p></blockquote> <div class="language- extra-class"><pre><code> ウォレットアドレス「%s」が無効です </code></pre></div><blockquote><p><code>E_LIMITTXSIZE</code></p></blockquote> <div class="language- extra-class"><pre><code> トランザクションサイズが制限を超えました </code></pre></div><blockquote><p><code>E_NOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code> ページまたはメニューのコンテンツが見つかりません </code></pre></div><blockquote><p><code>E_PARAMNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code> パラメータが見つかりません </code></pre></div><blockquote><p><code>E_PERMISSION</code></p></blockquote> <div class="language- extra-class"><pre><code> 全く許可しません </code></pre></div><blockquote><p><code>E_QUERY</code></p></blockquote> <div class="language- extra-class"><pre><code> データベースクエリエラー </code></pre></div><blockquote><p><code>E_RECOVERED</code></p></blockquote> <div class="language- extra-class"><pre><code> APIパニックエラーが発生します。パニックエラーが発生した場合はエラーを返します。このエラーは、見つけて修正する必要があるバグが発生したことを意味します。 </code></pre></div><blockquote><p><code>E_SERVER</code></p></blockquote> <div class="language- extra-class"><pre><code> サーバーエラー。 golang ライブラリ関数にエラーがある場合に戻ります。 \*msg\* フィールドにはエラーテキストメッセージが含まれます。 **E_SERVER** は、コマンドエラーに応答して表示される場合があります。入力パラメータが間違っているためにエラーが発生した場合は、関連するエラーに変更できます。別のケースでは、このエラーは無効な操作または不正なシステム構成を報告するため、より詳細な調査レポートが必要になります。 </code></pre></div><blockquote><p><code>E_SIGNATURE</code></p></blockquote> <div class="language- extra-class"><pre><code>Incorrect signature </code></pre></div><blockquote><p><code>E_STATELOGIN</code></p></blockquote> <div class="language- extra-class"><pre><code>`%s` is not a member of the ecosystem `%s` </code></pre></div><blockquote><p><code>E_TABLENOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Data sheet `%s` not found </code></pre></div><blockquote><p><code>E_TOKENEXPIRED</code></p></blockquote> <div class="language- extra-class"><pre><code>The session has expired `%s` </code></pre></div><blockquote><p><code>E_UNAUTHORIZED</code></p></blockquote> <div class="language- extra-class"><pre><code>Unauthorized. In case no login is performed or the session expires, except for `getuid, login` Any command other than **E_UNAUTHORIZED** returns an error. </code></pre></div><blockquote><p><code>E_UNKNOWNUID</code></p></blockquote> <div class="language- extra-class"><pre><code>Unknown UID </code></pre></div><blockquote><p><code>E_UPDATING</code></p></blockquote> <div class="language- extra-class"><pre><code>Nodes are updating the blockchain </code></pre></div><blockquote><p><code>E_STOPPING</code></p></blockquote> <div class="language- extra-class"><pre><code>Node is stopped </code></pre></div><blockquote><p><code>E_NOTIMPLEMENTED</code></p></blockquote> <div class="language- extra-class"><pre><code>Not yet achieved </code></pre></div><blockquote><p><code>E_BANNED</code></p></blockquote> <div class="language- extra-class"><pre><code>This account address is prohibited in `%s` </code></pre></div><blockquote><p><code>E_CHECKROLE</code></p></blockquote> <div class="language- extra-class"><pre><code>Access denied CLB Unavailable Interface </code></pre></div><hr> <blockquote><p>CLB ノードが使用できないインターフェース要求。</p></blockquote> <ul><li>metrics</li> <li>txinfo</li> <li>txinfoMultiple</li> <li>appparam</li> <li>appparams</li> <li>appcontent</li> <li>history</li> <li>balance</li> <li>block</li> <li>maxblockid</li> <li>blocks</li> <li>detailed_blocks</li> <li>ecosystemparams</li> <li>systemparams</li> <li>ecosystems</li> <li>ecosystemparam</li> <li>ecosystemname</li> <li>walletHistory</li> <li>tx_record</li></ul> <h2 id="request-type"><a href="#request-type" class="header-anchor">#</a> リクエストの種類 </h2> <p><strong>制服の使用</strong></p> <ul><li>application/x-www-form-urlencoded</li></ul> <h2 id="authentication-interface"><a href="#authentication-interface" class="header-anchor">#</a> Authentication Interface </h2> <p><a href="https://jwt.io" target="_blank" rel="noopener noreferrer">JWT token<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> 認証に使用されます。 JWT トークンは、受信後に各リクエストヘッダーに配置する必要があります: <code>Authorization: Bearer TOKEN_HERE</code>。</p> <h3 id="getuid"><a href="#getuid" class="header-anchor">#</a> getuid </h3> <p><strong>GET</strong>/ は一意の値を返し、秘密キーで署名してから、 <a href="#login">login</a> コマンドは、それをサーバーに送り返します。</p> <p><strong>login</strong> を呼び出すときに <strong>Authorization</strong> に渡す必要がある一時的な JWT トークンを生成します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/getuid </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>uid</code></p> <blockquote><p>署名番号。</p></blockquote></li> <li><p><code>token</code></p> <blockquote><p>ログイン時に渡される一時トークン。</p> <p>一時トークンのライフサイクルは 5 秒です。</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>サーバー識別子。</p></blockquote></li> <li><p><code>cryptoer</code></p> <blockquote><p>楕円曲線アルゴリズム。</p></blockquote></li> <li><p><code>hasher</code></p> <blockquote><p>ハッシュアルゴリズム。</p></blockquote></li></ul> <p><strong>応答例1</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "uid": "4999317241855959593", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....... .I7LY6XX4IP12En6nr8UPklE9U4qicqg3K9KEzGq_8zE" "network_id": "4717243765193692211" } </code></pre></div><p>認証が不要な場合（リクエストに <strong>Authorization</strong> が含まれている場合）には、以下のメッセージが返されます：</p> <ul><li><p><code>expire</code></p> <blockquote><p>有効期限です。</p></blockquote></li> <li><p><code>ecosystem</code></p> <p>エコシステム* > エコシステムID。</p></li> <li><p><code>key_id</code></p> <blockquote><p>アカウントアドレス。</p></blockquote></li> <li><p><code>address</code></p> <blockquote><p>ウォレットアドレス <code>XXXX-XXXX-.... -XXXX</code>です。</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>サーバーの識別子です。</p></blockquote></li></ul> <p><strong>応答例2</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "expire": "2159h59m49.4310543s", "ecosystem_id": "1", "key_id": "-654321", "address": "1196-...... -3496", "network_id": "1" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER</em></p> <h3 id="login"><a href="#login" class="header-anchor">#</a> login </h3> <p><strong>POST</strong>/ User authentication.</p> <blockquote><p><strong>getuid</strong>を最初に呼び出す必要があります。 getuidの一時的なJWTトークンは、リクエストヘッダで渡す必要があります。</p> <p>リクエストに成功した場合、レスポンスで受け取ったトークンは <strong>Authorization</strong> に含まれます。</p></blockquote> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/login </code></pre></div><ul><li><p><code>ecosystem</code></p> <blockquote><p>エコシステムID。</p> <p>指定しない場合、デフォルトで最初のエコシステム ID が使用されます。</p></blockquote></li> <li><p><code>expire</code></p> <blockquote><p>JWT トークンのライフサイクル (秒単位)、デフォルトは 28800 です。</p></blockquote></li> <li><p><code>pubkey</code></p> <blockquote><p>16 進数のアカウント公開キー。</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>アカウントアドレス <code>XXXX-... -XXXX</code>。</p> <p>公開キーがすでにブロックチェーンに保存されている場合は、このパラメータを使用します。 <em>pubkey</em> と一緒に使用することはできませんパラメータが併用されます。</p></blockquote></li> <li><p><code>signature</code></p> <blockquote><p>getuid 経由で受信した uid 署名。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>token</code></p> <blockquote><p>JWT トークン。</p></blockquote></li> <li><p><code>ecosystem_id</code></p> <blockquote><p>エコシステムID。</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>アカウントアドレスID。</p></blockquote></li> <li><p><code>account</code></p> <blockquote><p>ウォレットアドレス <code>XXXX-XXXX-..... -XXXX</code>。</p></blockquote></li> <li><p><code>notify_key</code></p> <blockquote><p>通知 ID。</p></blockquote></li> <li><p><code>isnode</code></p> <blockquote><p>アカウントアドレスがノードの所有者であるかどうか。値: <code>true,false</code>.</p></blockquote></li> <li><p><code>isowner</code></p> <blockquote><p>アカウントアドレスがエコシステムの作成者であるかどうか。値: <code>true,false</code>.</p></blockquote></li> <li><p><code>clb</code></p> <blockquote><p>ログインしたエコシステムが CLB かどうか。値: <code>true,false</code>.</p></blockquote></li> <li><p><code>roles</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>ロールリスト: <code>[{Role ID,Role Name}]</code>.</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....30l665h3v7lH85rs5jgk0", "ecosystem_id": "1", "key_id": "-54321", "account": "1285-... -7743-4282", "notify_key": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..... _JTFfheD0K4CfMbvVNpOJVMNDPx25zIDGir9g3ZZM0w", "timestamp": "1451309883", "roles": [ { "role_id": 1, "role_name": "Developer" } ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_UNKNOWNUID, E_SIGNATURE, E_STATELOGIN, E_EMPTYPUBLIC</em></p> <h2 id="server-side-command-interface"><a href="#server-side-command-interface" class="header-anchor">#</a> Server Side command interface </h2> <h3 id="version"><a href="#version" class="header-anchor">#</a> version </h3> <p><strong>GET</strong>/ 現在のサーバーのバージョンを返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/version </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json "1.3.0 branch.main commit.790..757 time.2021-08-23-08:20:19(UTC)" </code></pre></div><h2 id="data-request-function-interface"><a href="#data-request-function-interface" class="header-anchor">#</a> Data Request Function Interface </h2> <h3 id="balance"><a href="#balance" class="header-anchor">#</a> balance </h3> <p><strong>GET</strong>/ 現在のエコシステムのアカウントアドレスの残高をリクエストします。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/balance/{wallet} </code></pre></div><ul><li><p><code>wallet</code></p> <blockquote><p>アドレス識別子は、<code>int64、uint64、XXXX-... -XXXX</code>の任意の形式で指定できます。ユーザーが現在ログインしているエコシステム内のアドレスを検索します。</p></blockquote></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a> デフォルトの ecosystem 1</p> <blockquote><p>エコシステム ID。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>amount</code></p> <blockquote><p>The minimum unit of contract account balance.</p></blockquote></li> <li><p><code>money</code></p> <blockquote><p>Account balance.</p></blockquote></li> <li><p><code>total</code></p> <blockquote><p>Account balance.</p></blockquote></li> <li><p><code>utxo</code></p> <blockquote><p>UTXO account balance.</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "amount": "877450000000000", "money": "877.45", "total": "877450000000000", "utxo": "0" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_INVALIDWALLET</em></p> <h3 id="blocks"><a href="#blocks" class="header-anchor">#</a> blocks </h3> <p><strong>GET</strong>/ 各ブロック内のトランザクションに関連する追加情報を含むリストを返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/blocks </code></pre></div><ul><li><p><code>block_id</code> <a href="#omitempty">Omitempty</a> デフォルトは 0</p> <blockquote><p>クエリする開始ブロックの高さ。</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (デフォルトは 25、最大リクエストは 1000)</p> <blockquote><p>ブロックの数。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>Block height</code></p> <blockquote><p>ブロック内のトランザクションのリストと各トランザクションの追加情報。</p> <blockquote><ul><li><code>hash</code></li></ul> <blockquote><p>取引ハッシュ。</p></blockquote> <ul><li><code>contract_name</code></li></ul> <blockquote><p>契約名。</p></blockquote> <ul><li><code>params</code></li></ul> <blockquote><p>コントラクトパラメータの配列。</p></blockquote> <ul><li><code>key_id</code></li></ul> <blockquote><p>最初のブロックの場合、トランザクションに署名した最初のブロックのアカウントアドレスです。</p></blockquote> <blockquote><p>他のすべてのブロックの場合、トランザクションに署名したアカウントのアドレスです。</p></blockquote></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "1": [{"hash": "O1LhrjKznrYa0z5n5cej6p5Y1j5E9v/oV27VPRJmfgo=", "contract_name":"", "params":null, "key_id":-118432674655542910}] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_NOTFOUND</em></p> <h3 id="detailed-blocks"><a href="#detailed-blocks" class="header-anchor">#</a> detailed_blocks </h3> <p><strong>GET</strong>/ 各ブロック内のトランザクションに関する詳細な追加情報を含むリストを返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/detailed_blocks </code></pre></div><ul><li><p><code>block_id</code> <a href="#omitempty">Omitempty</a> デフォルトは 0</p> <blockquote><p>クエリする開始ブロックの高さ。</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (デフォルトは 25、最大リクエストは 1000)</p> <blockquote><p>ブロックの数。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><code>Block height</code> The block height.</li> <li><code>blockhead</code> ブロックヘッダには次のフィールドが含まれています。</li> <li><code>block_id</code> ブロックの高さ。</li> <li><code>time</code> ブロックの生成タイムスタンプ。</li> <li><code>key_id</code> ブロックに署名するアカウントのアドレス。</li> <li><code>node_position</code> ブロックを生成したノードの位置（名誉ノードリスト内）。</li> <li><code>version</code> ブロックの構造バージョン。</li> <li><code>hash</code> ブロックのハッシュ。</li> <li><code>node_position</code> ブロックを生成したノードの位置（名誉ノードリスト内）。</li> <li><code>key_id</code> ブロックに署名したアカウントのアドレス。</li> <li><em>time</em> ブロックの生成タイムスタンプ。</li> <li><em>tx_count</em> ブロック内のトランザクション数。</li> <li><em>size</em> ブロックのサイズ。</li> <li><em>rollback_hash</em> ブロックのロールバックハッシュ。</li> <li><em>merkle_root</em> ブロックのマークルツリー。</li> <li><em>bin_data</em> ブロックヘッダ、ブロック内のすべてのトランザクション、前のブロックのハッシュ、およびブロックを生成したノードの秘密鍵のシリアル化。</li> <li><em>transactions</em> ブロック内のトランザクションのリストと各トランザクションに関する追加情報。</li> <li><em>hash</em> トランザクションのハッシュ。</li> <li><em>contract_name</em> コントラクトの名前。</li> <li><em>params</em> コントラクトのパラメータ。</li> <li><em>key_id</em> このトランザクションに署名するアカウントのアドレス。</li> <li><em>time</em> トランザクションの生成タイムスタンプ。</li> <li><em>type</em> トランザクションのタイプ。</li> <li><em>size</em> トランザクションのサイズ。</li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json {"1": {"header": {"block_id":1, "time":1551069320, "ecosystem_id":0, "key_id":-118432674655542910, "node_position":0, "version":1}, "hash":"3NxhvswmpGvRdw8HdkrniI5Mx/q14Z4d5hwGKMp6KHI=", "ecosystem_id":0, "node_position":0, "key_id":-118432674655542910, "time":1551069320, "tx_count":1, "size": "1.69KiB", "rollbacks_hash":"I2JHugpbdMNxBdNW1Uc0XnbiXFtzB74yD9AK5YI5i/k=", "mrkl_root":"MTZiMjY2NGJjOWY3MDAyODlhYjkyMDVhZDQwNDgxNzkxMjY1MWJjNjczNDkyZjk5MWI2Y2JkMjAxNTIwYjUyYg==", "bin_data":null, "sys_update":false, "gen_block":false, "stop_count":0, "transactions":[ { "hash":"O1LhrjKznrYa0z5n5cej6p5Y1j5E9v/oV27VPRJmfgo=", "contract_name":"", "params":null, "key_id":0, "time":0, "type":0, "size": "300.00B" } ]} } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_NOTFOUND</em></p> <h3 id="data-id-data-hash"><a href="#data-id-data-hash" class="header-anchor">#</a> /data/{id}/data/{hash} </h3> <p><strong>GET</strong>/ 指定されたハッシュがバイナリウォッチ、フィールド、およびレコード内のデータと一致する場合、このリクエストはデータを返します。一致しない場合はエラーを返します。</p> <p>このリクエストではログインの認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /data/{id}/data/{hash} </code></pre></div><ul><li><p><code>id</code></p> <blockquote><p>レコードのID。</p></blockquote></li> <li><p><code>hash</code></p> <blockquote><p>リクエストデータのハッシュ。</p></blockquote></li></ul> <p><strong>応答</strong></p> <blockquote><p>バイナリデータ</p></blockquote> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: * { "name": "NFT Miner", "conditions": "ContractConditions(\"@1DeveloperCondition\")", "data": [ { "Type": "contracts", "Name": "NewNFTMiner", }, ... ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_NOTFOUND, E_HASHWRONG</em></p> <h3 id="data-table-id-column-hash"><a href="#data-table-id-column-hash" class="header-anchor">#</a> /data/{table}/id/{column}/{hash} </h3> <p><strong>GET</strong>/ 指定したハッシュが指定されたテーブル、フィールド、およびレコードのデータと一致する場合、リクエストはデータを返します。一致しない場合はエラーを返します。</p> <p>このリクエストではログインの認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /data/{table}/id/{column}/{hash} </code></pre></div><ul><li><p><code>table</code></p> <blockquote><p>データテーブルの名前。</p></blockquote></li> <li><p><code>id</code></p> <blockquote><p>レコードID。</p></blockquote></li> <li><p><code>column</code></p> <blockquote><p>データテーブルの名前（1つのみ）。</p></blockquote></li> <li><p><code>hash</code></p> <blockquote><p>ハッシュリクエストデータ。</p></blockquote></li></ul> <p><strong>応答</strong></p> <blockquote><p>バイナリデータ</p></blockquote> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: * Content-Disposition: attachment SetVar(this_page, @1voting_list).(this_table, @1votings) Include(@1pager_header) SetTitle("$@1voting_list$") Span(Class: text-muted h5 m0 mb ml-lg, Body: Span(Class: ml-sm, Body: "$@1votings_list_desc$")) AddToolButton(Title: $@1templates_list$, Page: @1voting_templates_list, Icon: icon-pin) AddToolButton(Title: $@1create$, Page: @1voting_create, Icon: icon-plus).Popup(60, $@1new_voting$) </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_NOTFOUND, E_HASHWRONG</em></p> <h3 id="keyinfo"><a href="#keyinfo" class="header-anchor">#</a> keyinfo </h3> <p><strong>GET</strong>/ 指定したアドレスに登録された役割を持つエコシステムのリストを返します。</p> <p>このリクエストではログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/keyinfo/{address} </code></pre></div><ul><li><p><code>address</code></p> <blockquote><p>Address identifier, you can specify <code>int64, uint64, xxxx -...-xxxx</code>.</p> <p>This request is query in all ecosystems.</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>エコシステムのIDです。</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>エコシステムの名前です。</p></blockquote></li> <li><p><code>roles</code></p> <blockquote><p><em>id</em> と <em>name</em> フィールドを持つ役割のリストです。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json [{ "ecosystem":"1", "name":"platform ecosystem", "roles":[{"id":"1","name":"Governancer"},{"id":"2","name":"Developer"}] }] </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER, E_INVALIDWALLET</em></p> <h3 id="wallethistory"><a href="#wallethistory" class="header-anchor">#</a> walletHistory </h3> <p><strong>GET</strong>/ 現在のアカウントのトランザクション履歴レコードを返します。IDによって検索されます。</p> <p><a href="#authorization">Authorization</a></p> <p><strong>請求</strong></p> <ul><li><p><code>searchType</code></p> <blockquote><p>検索タイプ（収入：Income, 支出：Outcom, 全て：All, デフォルト：All）。</p></blockquote></li> <li><p><code>page</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>ページ番号を指定します。デフォルトは最初のページで、最小値は1です。</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>取得するトランザクション数を指定します。デフォルトは20件で、最小値は1、最大値は500です。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/walletHistory?searchType=all&page=1&limit=10 </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>total</code></p> <blockquote><p>全エントリの合計数。</p></blockquote></li> <li><p><code>page</code></p> <blockquote><p>現在のページ番号。</p></blockquote></li> <li><p><code>limit</code></p> <blockquote><p>現在の検索数。</p></blockquote></li> <li><p><code>list</code> 配列内の各要素は以下のパラメータを含みます：</p> <ul><li><code>id</code> ストライプID。</li> <li><code>sender_id</code> 送信元のkey_id。</li> <li><code>sender_add</code> 送信元のアカウントアドレス。</li> <li><code>recipient_id</code> 受信元のkey_id。</li> <li><code>recipient_add</code> 受信元のアカウントアドレス。</li> <li><code>amount</code> トランザクションの金額。</li> <li><code>comment</code> 取引の備考。</li> <li><code>block_id</code> ブロックの高さ。</li> <li><code>tx_hash</code> トランザクションのハッシュ。</li> <li><code>created_at</code> トランザクションの作成時刻（ミリ秒のタイムスタンプ）。</li> <li><code>money</code> トランザクションの金額。</li></ul></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "page": 1, "limit": 10, "total": 617, "list": [ { "id": 650, "sender_id": 666081971617879..., "sender_add": "0666-0819-7161-xxxx-5186", "recipient_id": 666081971617879..., "recipient_add": "0666-0819-7161-xxxx-5186", "amount": "242250000", "comment": "taxes for execution of @1Export contract", "block_id": 209, "tx_hash": "a213bc767d710a223856d83515d53518075b56fb9e9c063bce8a256c20ff0775", "created_at": 1666001092090, "money": "0.00024225" } ... ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER</em></p> <h3 id="listwhere-name"><a href="#listwhere-name" class="header-anchor">#</a> listWhere/{name} </h3> <p><strong>GET</strong>/ 現在のエコシステムで指定されているデータテーブルのエントリに戻ります。返される列を指定できます。</p> <p><a href="#authorization">Authorization</a></p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>データテーブルの名前。</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p></li></ul> <blockquote><p>取得するレコードの最大数。デフォルトは25。</p></blockquote> <ul><li><code>offset</code> <a href="#omitempty">Omitempty</a></li></ul> <blockquote><p>ページネーションのオフセット。デフォルトは0。</p></blockquote> <ul><li><code>order</code> <a href="#omitempty">Omitempty</a></li></ul> <blockquote><p>ソート方法。デフォルトは <code>id ASC</code>。</p></blockquote> <ul><li><code>columns</code> <a href="#omitempty">Omitempty</a></li></ul> <blockquote><p>取得する列のリストをカンマ区切りで指定します。指定しない場合、すべての列が返されます。ただし、<code>id</code>列は常に返されます。</p></blockquote> <ul><li><code>where</code> <a href="#omitempty">Omitempty</a></li></ul> <blockquote><p>クエリの条件を指定します。</p> <p>例: id > 2 かつ name = "john" をクエリしたい場合</p> <p><code>where: {"id": {"$gt": 2}, "name": {"$eq": "john"}}</code> のように使用します。</p> <p>詳細は [DBFind](../ topics/script.md#dbfind) の where 構文を参照してください。</p></blockquote> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/listWhere/mytable </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>エントリーの総数。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列内の各要素には以下のパラメータが含まれます:</p></blockquote> <ul><li><code>id</code> <blockquote><p>ストライプID.</p></blockquote></li> <li><code>...</code> <blockquote><p>データテーブルの他の列</p></blockquote></li></ul></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 1, "list": [ { "account": "xxxx-0819-7161-xxxx-xxxx", "ecosystem": "1", "id": "12", "key": "avatar", "value": "{\"binary_id\": 4}" } ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER</em>,<em>E_TABLENOTFOUND</em></p> <h3 id="nodelistwhere-name"><a href="#nodelistwhere-name" class="header-anchor">#</a> nodelistWhere/{name} </h3> <p><strong>GET</strong>/ 指定したデータテーブルに戻ります。返される列を指定できます。データテーブルの型は <strong>BYTEA</strong> です。 16 進数のエンコード処理を行います。</p> <p><a href="#authorization">Authorization</a></p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>データテーブル名。</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>取得するエントリー数。デフォルトは25。</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>取得するエントリーのオフセット。デフォルトは0。</p></blockquote></li> <li><p><code>order</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>ソート方法。デフォルトは <code>id ASC</code>。</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>取得するカラムのリスト。カンマで区切って指定します。指定しない場合、すべてのカラムが返されます。ただし、<code>id</code>カラムは常に返されます。</p></blockquote></li> <li><p><code>where</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>クエリの条件</p> <p>例: id> 2 かつ name = john をクエリしたい場合</p> <p>以下のように使用します: where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}</p> <p>詳細については、[DBFind](../ topics/script.md#dbfind) の where 構文を参照してください。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/nodelistWhere/mytable </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>エントリーの総数。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列内の各要素には以下のパラメータが含まれます:</p></blockquote> <ul><li><code>id</code> <blockquote><p>ストライプのID。</p></blockquote></li> <li><code>...</code> <blockquote><p>データテーブルの他のカラム</p></blockquote></li></ul></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 1, "list": [ { "account": "xxxx-0819-7161-xxxx-xxxx", "ecosystem": "1", "id": "12", "key": "avatar", "value": "{\"binary_id\": 4}" } ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_SERVER</em>,<em>E_TABLENOTFOUND</em></p> <h2 id=""><a href="#" class="header-anchor">#</a> Get Metrics Interface</h2> <h3 id="metrics-keys"><a href="#metrics-keys" class="header-anchor">#</a> metrics/keys </h3> <p><strong>GET</strong>/ エコシステム 1 アカウントのアドレスの数を返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/keys </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 28 } </code></pre></div><h3 id="metrics-blocks"><a href="#metrics-blocks" class="header-anchor">#</a> metrics/blocks </h3> <p><strong>GET</strong>/ ブロック数を返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/blocks </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 28 } </code></pre></div><h3 id="metrics-transactions"><a href="#metrics-transactions" class="header-anchor">#</a> metrics/transactions </h3> <p><strong>GET</strong>/ トランザクションの合計数を返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/transactions </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 28 } </code></pre></div><h3 id="metrics-ecosystems"><a href="#metrics-ecosystems" class="header-anchor">#</a> metrics/ecosystems </h3> <p><strong>GET</strong>/ エコシステムの数を返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/ecosystems </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 28 } </code></pre></div><h3 id="metrics-honornodes"><a href="#metrics-honornodes" class="header-anchor">#</a> metrics/honornodes </h3> <p><strong>GET</strong>/ オナーノードの数を返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <div class="language- extra-class"><pre class="language-text"><code>GET /api/v2/metrics/honornodes </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": 28 } </code></pre></div><h2 id="ecosystem-interface"><a href="#ecosystem-interface" class="header-anchor">#</a> Ecosystem Interface </h2> <h3 id="ecosystemname"><a href="#ecosystemname" class="header-anchor">#</a> ecosystemname </h3> <p><strong>GET</strong>/ エコシステムの名前をその識別子で返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/ecosystemname?id=1 </code></pre></div><ul><li><p><em>id</em></p> <blockquote><p>エコシステムID。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "ecosystem_name": "platform_ecosystem" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_PARAMNOTFOUND</em></p> <h3 id="appparams-appid"><a href="#appparams-appid" class="header-anchor">#</a> appparams/{appid} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在または指定されたエコシステム内のアプリケーションパラメーターのリストを返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/appparams/{appid} </code></pre></div><ul><li><p><code>appid</code></p> <blockquote><p>アプリケーションのID。</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>エコシステムのID。指定しない場合、現在のエコシステムのパラメータが返されます。</p></blockquote></li> <li><p><code>names</code></p> <blockquote><p>取得するパラメータのリスト。</p> <p>カンマ区切りでパラメータ名を指定できます。例: <code>/api/v2/appparams/1?names=name,mypar</code>。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>配列の各要素には、以下のパラメータが含まれます。</p> <ul><li><em>name</em>：パラメータの名前。</li> <li><em>value</em>：パラメータの値。</li> <li><em>conditions</em>：パラメータの権限を変更します。</li></ul></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [{ "name": "name", "value": "MyState", "conditions": "true", }, { "name": "mypar", "value": "My value", "conditions": "true", }, ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="appparam-appid-name"><a href="#appparam-appid-name" class="header-anchor">#</a> appparam/{appid}/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在または指定されたエコシステム内のアプリケーション <strong>{name}</strong> のパラメータ <strong>{appid}</strong> を返しますに関連する情報は、</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/appparam/{appid}/{name}[?ecosystem=1] </code></pre></div><ul><li><p><code>appid</code></p> <blockquote><p>アプリケーションID。</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>リクエストされたパラメータの名前。</p></blockquote></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>エコシステムのID（省略可能なパラメータ）。</p> <p>デフォルトでは現在のエコシステムが返されます。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>パラメータのID。</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>パラメータの名前。</p></blockquote></li> <li><p><code>value</code></p> <blockquote><p>パラメータの値。</p></blockquote></li> <li><p><code>conditions</code></p> <blockquote><p>パラメータの変更権限。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "id": "10", "name": "par", "value": "My value", "conditions": "true" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_ECOSYSTEM, E_PARAMNOTFOUND</em></p> <h3 id="ecosystemparams"><a href="#ecosystemparams" class="header-anchor">#</a> ecosystemparams </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ エコシステムパラメータのリストを返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/ecosystemparams/[?ecosystem=... &names=...] </code></pre></div><ul><li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Ecosystem IDが指定されていない場合、現在のエコシステムIDが返されます。</p></blockquote></li> <li><p><code>names</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>カンマで区切られた要求パラメータのリストです。</p> <p>例: <code>/api/v2/ecosystemparams/?names=name,currency,logo</code>。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>各要素は、次のパラメータを含んでいます。</p> <ul><li><code>name</code></li></ul> <blockquote><p>パラメータの名前。</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>パラメータの値。</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>パラメータの変更権限。</p></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [{ "name": "name", "value": "MyState", "conditions": "true", }, { "name": "currency", "value": "MY", "conditions": "true", }, ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="ecosystemparam-name"><a href="#ecosystemparam-name" class="header-anchor">#</a> ecosystemparam/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在または指定されたエコシステムのパラメータ <strong>{name}</strong> に関する情報を返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/ecosystemparam/{name}[?ecosystem=1] </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>要求されたパラメータの名前。</p></blockquote></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>デフォルトでは、現在のエコシステム ID が返されます。</p></blockquote></li></ul> <p><strong>応答</strong></p> <blockquote><p>各要素は、次のパラメータを含んでいます。</p> <ul><li><code>name</code></li></ul> <blockquote><p>パラメータの名前。</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>パラメータの値。</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>パラメータの変更権限。</p></blockquote></blockquote> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "name": "currency", "value": "MYCUR", "conditions": "true" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="tables-limit-offset"><a href="#tables-limit-offset" class="header-anchor">#</a> tables/[?limit=... &offset=... ] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステムのデータテーブルのリストを返します。オフセットとエントリ数を設定できます。</p> <p><strong>請求</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>エントリの数、デフォルトは100、最大は1000です。</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>オフセット、デフォルトは0です。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/tables?limit=... &offset=... </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>データテーブル内のエントリの総数。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列の各要素には、次のパラメータが含まれています。</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>プレフィックスなしのデータテーブル名。</p></blockquote> <ul><li><code>count</code></li></ul> <blockquote><p>データテーブル内のエントリ数。</p></blockquote></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "100" "list": [{ "name": "accounts", "count": "10", }, { "name": "citizens", "count": "5", }, ] } </code></pre></div><h3 id="table-name"><a href="#table-name" class="header-anchor">#</a> table/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステムリクエストデータテーブルに関する情報を返します。</p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>データテーブル名。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/table/{table_name} </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>データテーブル名。</p></blockquote></li> <li><p><code>insert</code></p> <blockquote><p>新しいエントリを追加する権限。</p></blockquote></li> <li><p><code>new_column</code></p> <blockquote><p>フィールド追加の権限。</p></blockquote></li> <li><p><code>update</code></p> <blockquote><p>エントリを変更する権限。</p></blockquote></li> <li><p><code>columns</code></p> <blockquote><p>フィールドに関連する情報の配列。</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>フィールド名。</p></blockquote> <ul><li><code>type</code></li></ul> <blockquote><p>フィールドのデータ型。</p></blockquote> <ul><li><code>perm</code></li></ul> <blockquote><p>フィールド値の変更権限。</p></blockquote></blockquote></blockquote></li></ul> <h3 id="list-name-limit-offset-columns"><a href="#list-name-limit-offset-columns" class="header-anchor">#</a> list/{name}[?limit=... &offset=... &columns=... ] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステム内の指定されたデータテーブルエントリのリストを返します。オフセットとエントリ数を設定できます。</p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>データテーブル名。</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>エントリ数、デフォルトは25エントリ。</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>オフセット、デフォルトは0。</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>要求されたカラムのカンマ区切りリスト。指定されていない場合、すべてのカラムが返されます。idカラムは常に返されます。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/list/mytable?columns=name </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>エントリの総数。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列の各要素には、次のパラメータが含まれています。</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>エントリのID。</p></blockquote> <ul><li>要求されたカラムのシーケンス。</li></ul></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "10" "list": [{ "id": "1", "name": "John", }, { "id": "2", "name": "Mark", }, ] } </code></pre></div><h3 id="sections-limit-offset-lang"><a href="#sections-limit-offset-lang" class="header-anchor">#</a> sections[?limit=... &offset=... &lang=] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステムの <em>セクション</em> を返しますテーブルエントリのリストでは、オフセットとエントリ数を設定できます。</p> <p><em>role_access</em> の場合フィールドにロールのリストが含まれており、現在のロールが含まれていない場合、レコードは返されません。 <em>タイトル</em> フィールドのデータは、リクエストヘッダーの <em>Accept-Language</em> 言語リソースに置き換えられます。</p> <p><strong>請求</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>エントリの数。デフォルトは25エントリ。</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>オフセット。デフォルトは0。</p></blockquote></li> <li><p><code>lang</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>このフィールドは、マルチ言語リソースコードまたはローカライゼーションを指定します。例えば、<em>en, ja</em>です。指定したマルチ言語リソースが見つからない場合、例えば<em>en-US</em>の場合は、 <em>en</em>のマルチ言語リソースグループを検索します。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/sections </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p><em>sections</em> テーブルのエントリーの総数。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列の各要素には、アクションテーブルのすべての列に関する情報が含まれています。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "2" "list": [{ "id": "1", "title": "Development", "urlpage": "develop", ... }, ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_TABLENOTFOUND</em></p> <h3 id="row-name-id-columns"><a href="#row-name-id-columns" class="header-anchor">#</a> row/{name}/{id}[?columns=] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステム内の指定されたデータテーブルのエントリを返します。返される列を指定できます。</p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>データテーブル名。</p></blockquote></li> <li><p><code>id</code></p> <blockquote><p>エントリーのID。</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>要求された列のカンマ区切りリスト。指定されていない場合、すべての列が返されます。ID列は常に返されます。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/row/mytable/10?columns=name </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>value</code></p> <blockquote><p>受信した列の値の配列です。</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>エントリーのIDです。</p></blockquote> <ul><li>要求された列のシーケンスです。</li></ul></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "values": { "id": "10", "name": "John", } } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="row-name-colorn-id"><a href="#row-name-colorn-id" class="header-anchor">#</a> row/{name}/{column}/{id} </h3> <p>[Authorization] (#authorization)</p> <p><strong>GET</strong>/ 現在のエコシステムで指定されているデータテーブルのエントリに戻ります。返される列を指定できます。</p> <p><strong>請求</strong></p> <ul><li><p><code>Name</code></p> <blockquote><p>データテーブルの名前です。</p></blockquote></li> <li><p><code>colorn</code></p> <blockquote><p>データリストの名前です。</p></blockquote></li> <li><p><code>ID</code></p> <blockquote><p>ストライプIDです。</p></blockquote></li> <li><p><code>columns</code> [omitempty] (#omitempty)</p> <blockquote><p>要求されたリストのリストです。カンマで区切られています。指定されていない場合、すべての列が返されます。ID列はすべての場合に返されます。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /API/V2/ROW/MyTable/name/John? Columns = name </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>Value</code></p> <blockquote><p>受信カラムの値の配列です。</p></blockquote> <ul><li><p><code>ID</code></p> <blockquote><p>ストライプIDです。</p></blockquote></li> <li><p>その他の要求カラムのシーケンス</p></li></ul></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-type: Application/JSON {{ "Values": { "ID": "10", "name": "John", } } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="systemparams"><a href="#systemparams" class="header-anchor">#</a> systemparams </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ プラットフォームパラメータのリストを返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/systemparams/[?names=...] </code></pre></div><ul><li><p><code>names</code> <a href="#omitempty">Omitempty</a></p> <p>カンマで区切られたリクエストパラメータのリスト。例えば <code>/api/v2/systemparams/?names=max_columns,max_indexes</code>.</p></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>配列の各要素は以下のパラメータを含んでいます。</p></blockquote> <ul><li><p><code>name</code></p> <blockquote><p>パラメータ名です。</p></blockquote></li> <li><p><code>value</code></p> <blockquote><p>パラメータの値です。</p></blockquote></li> <li><p><code>conditions</code></p> <blockquote><p>パラメータの権限を変更します。</p></blockquote></li></ul></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [{ "name": "max_columns", "value": "100", "conditions": "ContractAccess("@1UpdateSysParam")", }, { "name": "max_indexes", "value": "1", "conditions": "ContractAccess("@1UpdateSysParam")", }, ] } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_PARAMNOTFOUND</em></p> <h3 id="history-name-id"><a href="#history-name-id" class="header-anchor">#</a> history/{name}/{id} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステム内の指定されたデータテーブル内のエントリの変更レコードを返します。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/history?name=contracts&id=5 </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>データテーブルの名前です。</p></blockquote></li> <li><p><code>id</code></p> <blockquote><p>エントリーのIDです。</p></blockquote></li></ul> <p><strong>応答</strong></p> <blockquote><ul><li><code>list</code></li></ul> <p>配列の各要素には、要求されたエントリの変更レコードが含まれます。</p></blockquote> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [ { "name": "default_page", "value": "P(class, Default Ecosystem Page)" }, { "menu": "default_menu" } ] } </code></pre></div><h3 id="interface-page-menu-snippet-name"><a href="#interface-page-menu-snippet-name" class="header-anchor">#</a> interface/{page|menu|snippet}/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 指定されたデータテーブル (ページ、メニュー、またはスニペット) <em>name</em> 内の現在のエコシステムを返しますフィールドのエントリ。</p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/interface/page/default_page /api/v2/interface/menu/default_menu /api/v2/interface/snippet/welcome </code></pre></div><p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>テーブル内のエントリの名前を指定します。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>エントリーID。</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>エントリー名。</p></blockquote></li> <li><p><code>other</code></p> <blockquote><p>テーブルの他の列。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "id": "1", "name": "default_page", "value": "P(Page content)", "default_menu": "default_menu", "validate_count": 1 } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_QUERY</em>, <em>E_NOTFOUND</em></p> <h2 id="contract-function-interface"><a href="#contract-function-interface" class="header-anchor">#</a> Contract Function Interface </h2> <h3 id="contracts-limit-offset"><a href="#contracts-limit-offset" class="header-anchor">#</a> contracts[?limit=... &offset=... ] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 現在のエコシステム内のコントラクトのリストを返します。オフセットとエントリ数を設定できます。</p> <p><strong>請求</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>オフセット、デフォルトは 0 です。</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>オフセット。デフォルトは 0 です。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/contracts </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>エントリーの総数です。</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>配列の各要素には、以下のパラメータが含まれています。</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>コントラクトのIDです。</p></blockquote> <ul><li><code>name</code></li></ul> <blockquote><p>コントラクトの名前です。</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>コントラクトの内容です。</p></blockquote> <ul><li><code>wallet_id</code></li></ul> <blockquote><p>コントラクトが紐づいているアカウントのアドレスです。</p></blockquote> <ul><li><code>address</code></li></ul> <blockquote><p>コントラクトに紐づいているウォレットアドレス <code>XXXX-...-XXXX</code> です。</p></blockquote> <ul><li><code>ecosystem_id</code></li></ul> <blockquote><p>コントラクトが所属しているエコシステムのIDです。</p></blockquote> <ul><li><code>app_id</code></li></ul> <blockquote><p>コントラクトが所属しているアプリケーションのIDです。</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>コントラクトの権限を変更します。</p></blockquote> <ul><li><code>token_id</code></li></ul> <blockquote><p>コントラクト料金支払いに使用されるパスが所属するエコシステムのIDです。</p></blockquote></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "10" "list": [{ "id": "1", "name": "MainCondition", "token_id": "1", "wallet_id": "0", "value": "contract MainCondition { conditions { if(EcosysParam(`founder_account`)! =$key_id) { warning `Sorry, you dont have access to this action.` } } }", "address": "0000-0000-0000-0000-0000-0000", "conditions": "ContractConditions(`MainCondition`)" }, ... ] } </code></pre></div><h3 id="contract-name"><a href="#contract-name" class="header-anchor">#</a> contract/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ 指定されたコントラクトに関する情報を返します。デフォルトでは、現在のエコシステムでコントラクトをクエリします。</p> <p><strong>請求</strong></p> <ul><li><p><em>name</em></p> <blockquote><p>Contract name.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/contract/mycontract </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>コントラクトのVM内のIDです。</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>エコシステムID <code>@1MainCondition</code> を持つコントラクト名です。</p></blockquote></li> <li><p><code>state</code></p> <blockquote><p>コントラクトのエコシステムIDです。</p></blockquote></li> <li><p><code>walletid</code></p> <blockquote><p>コントラクトが紐づいているアカウントのアドレスです。</p></blockquote></li> <li><p><code>tokenid</code></p> <blockquote><p>コントラクトの支払いに使用されるパスのエコシステムIDです。</p></blockquote></li> <li><p><code>address</code></p> <blockquote><p>コントラクトに紐づいているウォレットアドレス <code>XXXX-...-XXXX</code> です。</p></blockquote></li> <li><p><code>tableid</code></p> <blockquote><p>コントラクトが存在する <em>contracts</em> テーブル内のエントリーのIDです。</p></blockquote></li> <li><p><code>fields</code></p> <blockquote><p>配列には、コントラクトの <strong>data</strong> セクションの各パラメータの構造情報が含まれています。</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>パラメータ名です。</p></blockquote></blockquote></blockquote> <blockquote><blockquote><ul><li><code>type</code></li></ul> <p>パラメータのタイプです。</p> <ul><li><em>optional</em></li></ul> <p>パラメータのオプションです。 `true` はオプションパラメータを示し、`false` は必須パラメータを示します。</p></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "fields" : [ {"name": "amount", "type": "int", "optional": false}, {"name": "name", "type": "string", "optional": true} ], "id": 150, "name":"@1mycontract", "tableid" : 10, } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_CONTRACT</em></p> <h3 id="sendtx"><a href="#sendtx" class="header-anchor">#</a> sendTX </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong>/ パラメータでトランザクションを受け取り、それらをトランザクションキューに追加し、リクエストが正常に実行された場合はトランザクションハッシュを返します。このハッシュはブロック内の対応するトランザクションを生成し、エラー応答の場合はエラーテキストメッセージに含まれます。</p> <p><strong>請求</strong></p> <ul><li><p><code>tx_key</code></p> <blockquote><p>トランザクションの内容。このパラメータは任意の名前を指定でき、複数のトランザクションの受信をサポートします。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/sendTx Headers: Content-Type: multipart/form-data Parameters: tx1 - Transaction 1 txN - Trading N </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>hashes</code></p> <blockquote><p>トランザクションのハッシュの配列です。</p> <blockquote><ul><li><code>tx1</code></li></ul> <blockquote><p>トランザクション1のハッシュです。</p></blockquote> <ul><li><code>txN</code></li></ul> <blockquote><p>トランザクションNのハッシュです。</p></blockquote></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "hashes": { "tx1": "67afbc435634..... ", "txN": "89ce4498eaf7..... ", } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_LIMITTXSIZE</em>,<em>E_BANNED</em></p> <h3 id="txstatus"><a href="#txstatus" class="header-anchor">#</a> txstatus </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong>/ 指定されたトランザクションハッシュのブロック ID とエラーメッセージを返します。ブロック ID とエラーテキストメッセージの戻り値が null の場合、トランザクションはまだブロックに含まれていません。</p> <p><strong>請求</strong></p> <ul><li><p><em>data</em></p> <blockquote><p>トランザクションハッシュの JSON リスト。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>{"hashes":["contract1hash", "contract2hash", "contract3hash"]} </code></pre></div><div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/txstatus/ </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>results</code></p> <blockquote><p>トランザクションのハッシュをキーとし、データ辞書内のトランザクション詳細を値として使用します。</p> <p><code>hash</code></p> <blockquote><p>トランザクションのハッシュです。</p> <ul><li><code>blockid</code></li></ul> <p>トランザクションの実行が成功した場合、ブロックのIDが返されます。トランザクションの実行が失敗した場合、[0]{.title-ref} のブロックIDが返されます。</p> <ul><li><code>result</code></li></ul> <p>トランザクションの結果を <strong>$result</strong> 変数を通じて返します。</p> <ul><li><code>errmsg</code></li></ul> <p>トランザクションの実行に失敗した場合、エラーテキストメッセージが返されます。</p></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "results": { "hash1": { "blockid": "3123", "result": "", }, "hash2": { "blockid": "3124", "result": "", } } } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_HASHWRONG, E_HASHNOTFOUND</em></p> <h3 id="txinfo-hash"><a href="#txinfo-hash" class="header-anchor">#</a> txinfo/{hash} </h3> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>GET</strong>/</p> <p>ブロック ID や確認の数など、指定されたハッシュのトランザクションに関する情報を返します。オプションのパラメーターが指定されている場合は、コントラクト名とそれに関連するパラメーターも返します。</p> <p><strong>請求</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>トランザクションのハッシュ。</p></blockquote></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>契約詳細パラメータ識別子。このトランザクションに関連する契約詳細を取得するには、<code>contractinfo=1</code> を指定します。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/txinfo/c7ef367b494c7ce855f09aa3f1f2af7402535ea627fa615ebd63d437db5d0c8a?contractinfo=1 </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>blockid</code></p> <blockquote><p>値が「0」の場合、そのハッシュに対するトランザクションは見つかりませんでした。</p></blockquote></li> <li><p><code>confirm</code></p> <blockquote><p>このブロック <em>blockid</em> の承認数です。</p></blockquote></li> <li><p><code>data</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p><code>contentinfo=1</code> が指定されている場合、このパラメータには契約の詳細が返されます。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "blockid": "9", "confirm": 11, "data": { "block": "9", "contract": "@1NewContract", "params": { "ApplicationId": 1, "Conditions": "true", "Value": "contract crashci4b {\n\t\t\tdata {}\n\t\t\t}" } } } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_HASHWRONG</em></p> <h3 id="txinfomultiple"><a href="#txinfomultiple" class="header-anchor">#</a> txinfoMultiple </h3> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>GET</strong>/</p> <p>指定されたハッシュのトランザクション関連情報を返します。</p> <p><strong>請求</strong></p> <ul><li><p><code>data</code></p> <ul><li><code>hashes</code> <blockquote><p>トランザクションハッシュのリストです。</p></blockquote></li></ul></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>契約の詳細に関連するこのトランザクションの契約詳細パラメーター識別子を指定するには、<code>contractinfo=1</code>を指定します。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>data: {"hashes":["contract1hash", "contract2hash", "contract3hash"]} </code></pre></div><div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/txinfoMultiple </code></pre></div><p><strong>応答</strong></p> <ul><li><code>results</code> <blockquote><p>トランザクションハッシュがデータ辞書のキーとして使用され、トランザクションの詳細が値として使用されます。</p> <blockquote><p><code>hash</code></p> <blockquote><p>トランザクションハッシュ。</p></blockquote> <blockquote><p><code>blockid</code></p></blockquote> <blockquote><p>そのハッシュに対してトランザクションが見つからない場合は、値が <code>0</code> です。</p></blockquote> <blockquote><p><code>confirm</code></p></blockquote> <blockquote><p>このブロック <em>blockid</em> の承認数。</p></blockquote> <blockquote><p><code>data</code></p></blockquote> <blockquote><p><code>contentinfo=1</code> が指定されている場合、契約の詳細がこのパラメーターに返されます。</p></blockquote></blockquote></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "results": { "hash1": { "blockid": "3123", "confirm": "5", }, "hash2": { "blockid": "3124", "confirm": "3", } } } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_HASHWRONG</em></p> <h3 id="page-validators-count-name"><a href="#page-validators-count-name" class="header-anchor">#</a> /page/validators_count/{name} </h3> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>GET</strong></p> <p>指定されたページで検証されるノードの数を返します。</p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p><code>@ecosystem_id%%page_name%</code> 形式のエコシステム ID を含むページ名、たとえば <code>@1main_page</code>。エコシステム ID をお持ちでない場合は、デフォルトで最初のエコシステムページを検索します</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/page/validators_count/@2page_name </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>validate_count</code></p> <blockquote><p>ページに対して検証するノードの数を指定します。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json {"validate_count":1} </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="content-menu-page-name"><a href="#content-menu-page-name" class="header-anchor">#</a> content/menu|page/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong></p> <p>テンプレートエンジンによる処理の結果である、指定されたページまたはメニュー名のコード JSON オブジェクトのツリーを返します。</p> <p><strong>請求</strong></p> <ul><li><p><code>name</code></p> <blockquote><p><code>@ecosystem_id%%page_name%</code> 形式のエコシステム ID を含むページ名またはメニュー名 (例: <code>@1main_page</code>。エコシステム ID が含まれていない場合は、デフォルトで現在のエコシステムページまたはメニューを検索します。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content/page/default </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>menu</code> || <code>title</code></p> <blockquote><p>リクエスト <em>content/page/...</em> でリクエストされたページが所属するメニューの名前です。</p></blockquote></li> <li><p><code>menutree</code></p> <blockquote><p>リクエスト <em>content/page/...</em> でリクエストされたページのメニューのJSONオブジェクトツリーです。</p></blockquote></li> <li><p><code>title</code> --head for the menu <em>content/menu/...</em></p> <blockquote><p>リクエスト <em>content/menu/...</em> でリクエストされたメニューのタイトルです。</p></blockquote></li> <li><p><code>tree</code></p> <blockquote><p>ページまたはメニューのJSONオブジェクトツリーです。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "tree": {"type":"......" , "children": [ {...} , {...} ] }, } </code></pre></div><p><strong>エラー応答</strong></p> <p><code>E_NOTFOUND</code></p> <h3 id="content-source-name"><a href="#content-source-name" class="header-anchor">#</a> content/source/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong></p> <p>指定されたページ名のコード化された JSON オブジェクトのツリーを返します。関数の実行やデータの受信は行いません。返された JSON オブジェクトツリーはページテンプレートに対応しており、ビジュアルページデザイナーで使用できます。ページが見つからない場合は、404 エラーが返されます。 Request """""""</p> <ul><li><p><code>name</code></p> <blockquote><p><code>@ecosystem_id%%page_name%</code> 形式のエコシステム ID を含むページ名、たとえば <code>@1main_page</code>。エコシステム ID が含まれていない場合は、デフォルトで現在のエコページを検索します。</p></blockquote></li></ul> <p><strong>応答</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content/source/default </code></pre></div><ul><li><p><code>tree</code></p> <blockquote><p>JSON object tree of the page.</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "tree": {"type":"......" , "children": [ {...} , {...} ] }, } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="content-hash-name"><a href="#content-hash-name" class="header-anchor">#</a> content/hash/{name} </h3> <p><strong>POST</strong></p> <p>指定されたページ名の SHA256 ハッシュを返します。ページが見つからない場合は 404 エラーを返します。</p> <p>このリクエストにはログイン認証は必要ありません。他のノードにリクエストを行うときに正しいハッシュを受け取るには、以下も渡す必要があります。 <em>ecosystem,keyID,roleID,isMobile</em>パラメータ。他のエコシステムからページを受信するには、エコシステム ID をページ名の前に付ける必要があります。例: <code>@2mypage</code>。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content/hash/default </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>エコシステム ID を含むページの名前。</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>エコシステムIDです。</p></blockquote></li> <li><p><code>keyID</code></p> <blockquote><p>アカウントアドレスです。</p></blockquote></li> <li><p><code>roleID</code></p> <blockquote><p>ロールIDです。</p></blockquote></li></ul> <p><strong>応答</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>16 進数のハッシュ。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "hash": "b631b8c28761b5bf03c2cfbc2b49e4b6ade5a1c7e2f5b72a6323e50eae2a33c6" } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND, E_SERVER, E_HEAVYPAGE</em></p> <h3 id="content"><a href="#content" class="header-anchor">#</a> content </h3> <p><strong>POST</strong></p> <p><strong>template</strong> パラメータからページコードの JSON オブジェクトの数を返します。オプションのパラメータ <strong>source</strong> が「true または 1」に指定されている場合、この JSON オブジェクトツリーは関数を実行せず、データを受け取りません。。この JSON オブジェクトツリーは、ビジュアルページデザイナーで使用できます。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <ul><li><p><code>template</code></p> <blockquote><p>ページコード。</p></blockquote></li> <li><p><code>source</code></p> <blockquote><p><code>true or 1</code> が指定された場合、JSON オブジェクトツリーは何も機能せずにデータを受け取ります。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>tree</code></p> <blockquote><p>JSON オブジェクトツリー。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "tree": {"type":"......" , "children": [ {...} , {...} ] }, } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="maxblockid"><a href="#maxblockid" class="header-anchor">#</a> maxblockid </h3> <p><strong>GET</strong>/ 現在のノード上の最大のブロック ID を返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/maxblockid </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>max_block_id</code></p> <blockquote><p>現在のノード上の最大のブロック ID。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "max_block_id" : 341, } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="block-id"><a href="#block-id" class="header-anchor">#</a> block/{id} </h3> <p><strong>GET</strong>/</p> <p>指定されたブロック ID に関する情報を返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>Block ID.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/block/32 </code></pre></div><p><strong>応答</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>ブロックのハッシュです。</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>ブロックに署名したアカウントのアドレスです。</p></blockquote></li> <li><p><code>time</code></p> <blockquote><p>ブロックの生成タイムスタンプです。</p></blockquote></li> <li><p><code>tx_count</code></p> <blockquote><p>ブロック内のトランザクションの合計数です。</p></blockquote></li> <li><p><code>rollbacks_hash</code></p> <blockquote><p>ブロックのロールバックハッシュです。</p></blockquote></li> <li><p><code>node_position</code></p> <blockquote><p>ブロックのノード位置です。</p></blockquote></li></ul> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "hash": "1x4S5s/zNUTopP2YK43SppEyvT2O4DW5OHSpQfp5Tek=", "key_id": -118432674655542910, "time": 1551145365, "tx_count": 3, "rollbacks_hash": "47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=", "node_position": 0, } </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="avatar-ecosystem-member"><a href="#avatar-ecosystem-member" class="header-anchor">#</a> avatar/{ecosystem}/{member} </h3> <p><strong>GET</strong>/ <em>member</em> テーブル内のユーザーのアバターを返します (ログインなしで利用可能)。</p> <p><strong>請求</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>エコシステムID。</p></blockquote></li> <li><p><code>member</code></p> <blockquote><p>ユーザーのアカウントアドレス。 (xxxx-... -xxxx)</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/avatar/1/1234-2134-... -4321 </code></pre></div><p><strong>応答</strong></p> <p>リクエストヘッダー <em>Content-Type</em> は画像タイプであり、画像データは応答本文で返されます。</p> <p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: image/png </code></pre></div><p><strong>エラー応答</strong></p> <p><em>E_NOTFOUND</em> <em>E_SERVER</em></p> <h3 id="config-centrifugo"><a href="#config-centrifugo" class="header-anchor">#</a> config/centrifugo </h3> <p><strong>GET</strong>/</p> <p>centrifugo のホストアドレスとポートを返します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/config/centrifugo </code></pre></div><p><strong>応答</strong></p> <p>応答結果の形式は <code>http://address:port</code>、例: <code>http://127.0.0.1:8100</code>。</p> <p><strong>エラー応答</strong></p> <p><em>E_SERVER</em></p> <h3 id="updnotificator"><a href="#updnotificator" class="header-anchor">#</a> updnotificator </h3> <p><strong>POST</strong>/ (廃棄)</p> <p>まだ送信されていないすべてのメッセージを centrifugo 通知サービスに送信します。指定されたエコシステムとメンバーにメッセージのみを送信します。</p> <p>このリクエストにはログイン認証は必要ありません。</p> <p><strong>請求</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>メンバーのアカウントアドレス。</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>エコシステムID。</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/updnotificator </code></pre></div><p><strong>応答例</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "result": true } </code></pre></div><h3 id="special-instructions"><a href="#special-instructions" class="header-anchor">#</a> Special instructions </h3> <h4 id="omitempty"><a href="#omitempty" class="header-anchor">#</a> Omitempty </h4> <p>フィールドにomitempty属性がある場合、それはフィールドがオプションのパラメータであることを意味します。</p> <h4 id="authorization"><a href="#authorization" class="header-anchor">#</a> Authorization </h4> <p>Authorizationタグのあるインターフェースでログイン認証が必要なインターフェースの場合、リクエストヘッダーにAuthorizationを追加するなどします。</p> <p>key = Authorization value = "Bearer + <a href="#login">login token</a>"</p> <div class="language-text extra-class"><pre class="language-text"><code>Authorization Bearer eyJhbGciOiJI..... kBZgGIlPhfXNZJ73RiZtM </code></pre></div></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/IBAX-io/documentation/edit/master/docs/ja/reference/api2.md" target="_blank" rel="noopener noreferrer">GitHubでこのページを編集する</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">最終更新:</span> <span class="time">2023/7/6 18:59:03</span></div></footer> <div class="page-nav"><p class="inner"> <span class="next"><a href="/ja/reference/platform-parameters.html"> プラットフォームパラメータ </a> → </span></p></div> </main></div><div class="global-ui"></div></div> <script src="/assets/js/app.d049f7ab.js" defer></script><script src="/assets/js/2.8d94a0db.js" defer></script><script src="/assets/js/93.e37b6b5d.js" defer></script> </body> </html>