RESTful API v2 </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#error-response-handling" class="sidebar-link">Fehlerbehandlung </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#error-list" class="sidebar-link">Fehlerliste </a></li></ul></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#request-type" class="sidebar-link">Request Type </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#authentication-interface" class="sidebar-link">Authentifizierung </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#getuid" class="sidebar-link">getuid </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#login" class="sidebar-link">Anmeldung </a></li></ul></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#server-side-command-interface" class="sidebar-link">Dienstbefehle </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#version" class="sidebar-link">Ausführung </a></li></ul></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#data-request-function-interface" class="sidebar-link">Datenabfragefunktionen </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#balance" class="sidebar-link">Balance </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#blocks" class="sidebar-link">Blöcke </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#detailed-blocks" class="sidebar-link">detaillierte Blöcke </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#data-id-data-hash" class="sidebar-link">/data/{id}/data/{hash} </a></li><li class="sidebar-sub-header"><a href="/de/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="/de/reference/api2.html#keyinfo" class="sidebar-link">keyinfo </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#wallethistory" class="sidebar-link">walletHistory </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#listwhere-name" class="sidebar-link">listWhere/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#nodelistwhere-name" class="sidebar-link">nodelistWhere/{name} </a></li></ul></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#-2" class="sidebar-link">Get Metrics Interface</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#metrics-keys" class="sidebar-link">metrics/keys </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#metrics-blocks" class="sidebar-link">metrics/blocks </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#metrics-transactions" class="sidebar-link">metrics/transactions </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#metrics-ecosystems" class="sidebar-link">metrics/ecosystems </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#metrics-honornodes" class="sidebar-link">metrics/honornodes </a></li></ul></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#ecosystem-interface" class="sidebar-link">Ecosystem Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#ecosystemname" class="sidebar-link">ecosystemname </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#appparams-appid" class="sidebar-link">appparams/{appid} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#appparam-appid-name" class="sidebar-link">appparam/{appid}/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#ecosystemparams" class="sidebar-link">Ökosystemparam </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#ecosystemparam-name" class="sidebar-link">ecosystemparam/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#tables-limit-offset" class="sidebar-link">tables/[?limit=…&offset=…] </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#table-name" class="sidebar-link">table/{name} </a></li><li class="sidebar-sub-header"><a href="/de/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="/de/reference/api2.html#sections-limit-offset-lang" class="sidebar-link">sections\[?limit=\... &offset=\... &lang=\] </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#row-name-id-columns" class="sidebar-link">row/{name}/{id}[?columns=] </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#row-name-colorn-id" class="sidebar-link">row/{name}/{column}/{id} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#systemparams" class="sidebar-link">systemparams </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#history-name-id" class="sidebar-link">history/{name}/{id} </a></li><li class="sidebar-sub-header"><a href="/de/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="/de/reference/api2.html#contract-function-interface" class="sidebar-link">Vertragsfunktionen </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/de/reference/api2.html#contracts-limit-offset" class="sidebar-link">contracts[?limit=…&offset=…] </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#contract-name" class="sidebar-link">contract/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#sendtx" class="sidebar-link">sendTX </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#txstatus" class="sidebar-link">txstatus </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#txinfo-hash" class="sidebar-link">txinfo/{hash} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#txinfomultiple" class="sidebar-link">txinfoMultiple </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#page-validators-count-name" class="sidebar-link">/page/validators_count/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#content-menu-page-name" class="sidebar-link">content/menu|page/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#content-source-name" class="sidebar-link">content/source/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#content-hash-name" class="sidebar-link">content/hash/{name} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#content" class="sidebar-link">Inhalt </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#maxblockid" class="sidebar-link">maxblockid </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#block-id" class="sidebar-link">block/{id} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#avatar-ecosystem-member" class="sidebar-link">avatar/{ecosystem}/{member} </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#config-centrifugo" class="sidebar-link">config/centrifugo </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#updnotificator" class="sidebar-link">updnotificator </a></li><li class="sidebar-sub-header"><a href="/de/reference/api2.html#special-instructions" class="sidebar-link">Special instructions </a></li></ul></li></ul></li><li><a href="/de/reference/platform-parameters.html" class="sidebar-link">Plattformparameter </a></li><li><a href="/de/reference/backend-config.html" class="sidebar-link">Serverkonfigurationsdatei </a></li><li><a href="/de/reference/desync_monitor.html" class="sidebar-link">Synchronisiertes Überwachungstool </a></li><li><a href="/de/reference/json-rpc.html" class="sidebar-link">JSON-RPC Application Programming Interface </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>AAlle von Weaver bereitgestellten Funktionen, einschließlich Authentifizierung, Empfang von Ökosystemdaten, Fehlerbehandlung, Datenbanktabellenoperationen, Seiten- und Vertragsimplementierung, sind über die REST-API von IBAX verfügbar.</p> <p>Mit der REST-API können Entwickler auf alle Plattformfunktionen zugreifen, ohne Weaver zu verwenden.</p> <p>API-Befehlsaufrufe werden durch Adressieren von <code>/api/v2/command/[param]</code> ausgeführt, wobei <code>command</code> der Befehlsname und <code>param</code> ein zusätzlicher Parameter ist. Die Anfrageparameter müssen im Format <code>Content-Type: x-www-form-urlencoded</code> gesendet werden. Das Ergebnis der Serverantwort liegt im JSON-Format vor.</p> <ul><li><a href="#error-response-handling">Fehlerbehandlung</a> <ul><li><a href="#error-list">Fehlerliste</a></li></ul></li></ul> <ul><li><a href="#request-type">Request Type</a></li></ul> <ul><li><p><a href="#authentication-interface">Authentifizierung</a></p> <ul><li><a href="#getuid">getuid</a></li> <li><a href="#login">Anmeldung</a></li></ul></li> <li><p><a href="#server-side-command-interface">APIs für CLB nicht verfügbar</a></p></li> <li><p><a href="#service-commands">Service commands</a></p> <ul><li><a href="#version">Ausführung</a></li></ul></li> <li><p><a href="#data-request-function-interface">Datenanforderungsfunktionen</a></p> <ul><li><a href="#balance">Guthaben</a></li> <li><a href="#blocks">Blöcke</a></li> <li><a href="#detailed-blocks">detaillierte Blöcke</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">Schlüsselinfo</a></li></ul> <ul><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><p><a href="#get-metrics-interface">Metriken abrufen</a></p> <ul><li><a href="#metrics-keys">Tasten</a></li> <li><a href="#metrics-blocks">Blöcke</a></li> <li><a href="#metrics-transactions">Transaktionen</a></li> <li><a href="#metrics-ecosystems">Ökosysteme</a></li> <li><a href="#metrics-honornodes">Vollständige Knoten</a></li></ul></li> <li><p><a href="#%C3%B6kosystem">Ökosystem</a></p> <ul><li><a href="#ecosystem-interface">Ökosystemname</a></li> <li><a href="#ecosystemname">Ökosysteme</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">Ökosystemparameter</a></li> <li><a href="#ecosystemparam-name">Ökosystemparam/{Name}</a></li> <li><a href="#tables-limit-offset">tables/[?limit=…&offset=…]</a></li> <li><a href="#table-name">Tabelle/{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">Systemparameter</a></li> <li><a href="#history-name-id">Geschichte/{Name}/{ID}</a></li> <li><a href="#interface-page-menu-snippet-name">interface/{page|menu|block}/{name}</a></li></ul></li> <li><p><a href="#contract-function-interface">Vertragsfunktionen</a></p> <ul><li><a href="#contracts-limit-offset">verträge[?limit=…&offset=…]</a></li> <li><a href="#contract-name">Vertrag/{Name}</a></li> <li><a href="#sendtx">sendeTX</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">Inhalt/Menü|Seite/{Name}</a></li> <li><a href="#content-source-name">Inhalt/Quelle/{Name}</a></li> <li><a href="#content-hash-name">Inhalt/Hash/{Name}</a></li> <li><a href="#content">Inhalt</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/zentrifuge</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> Fehlerbehandlung </h2> <p>Wenn die Anfrage erfolgreich ausgeführt wird, wird ein Statuscode <code>200</code> zurückgegeben. Tritt ein Fehler auf, wird zusätzlich zum Fehlerstatus ein JSON-Objekt mit folgenden Feldern zurückgegeben:</p> <ul><li>Error</li></ul> <p>Fehlerkennung.</p> <ul><li>Nachricht</li></ul> <p>Der im Fehlerfall zurückgegebene Text.</p> <ul><li>Parameter</li></ul> <p>Zusätzliche Parameter des Fehlers, die im Fehlerfall im zurückgegebenen Text enthalten sein können.</p> <blockquote><p>Response example</p></blockquote> <p>400 (Bad request)</p> <p>Content-Type: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"err"</span><span class="token operator">:</span> <span class="token string">"E_INVALIDWALLET"</span><span class="token punctuation">,</span> <span class="token property">"msg"</span><span class="token operator">:</span> <span class="token string">"Wallet 1234-5678-9012-3444-3488 is not valid"</span><span class="token punctuation">,</span> <span class="token property">"params"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"1234-5678-9012-3444-3488"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div><h3 id="error-list"><a href="#error-list" class="header-anchor">#</a> Fehlerliste </h3> <blockquote><p><code>E_CONTRACT</code></p></blockquote> <div class="language- extra-class"><pre><code>No `%s` contract exists </code></pre></div><blockquote><p><code>E_DBNIL</code></p></blockquote> <div class="language- extra-class"><pre><code>Leere Datenbank </code></pre></div><blockquote><p><code>E_DELETEDKEY</code></p></blockquote> <div class="language- extra-class"><pre><code>Kontoadresse gesperrt </code></pre></div><blockquote><p><code>E_ECOSYSTEM</code></p></blockquote> <div class="language- extra-class"><pre><code>Ökosystem `%d` existiert nicht </code></pre></div><blockquote><p><code>E_EMPTYPUBLIC</code></p></blockquote> <div class="language- extra-class"><pre><code>Ungültiger öffentlicher Schlüssel für das Konto </code></pre></div><blockquote><p><code>E_KEYNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Kontoadresse nicht gefunden </code></pre></div><blockquote><p><code>E_HASHWRONG</code></p></blockquote> <div class="language- extra-class"><pre><code>Falscher Hash </code></pre></div><blockquote><p><code>E_HASHNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Nicht gefunden </code></pre></div><blockquote><p><code>E_HEAVYPAGE</code></p></blockquote> <div class="language- extra-class"><pre><code>Zu viele Seiten geladen </code></pre></div><blockquote><p><code>E_INVALIDWALLET</code></p></blockquote> <div class="language- extra-class"><pre><code>Ungültige Wallet-Adresse `%s` </code></pre></div><blockquote><p><code>E_LIMITTXSIZE</code></p></blockquote> <div class="language- extra-class"><pre><code>Größe einer Transaktion außerhalb des Limits </code></pre></div><blockquote><p><code>E_NOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Seiten- oder Menüinhalt nicht gefunden </code></pre></div><blockquote><p><code>E_PARAMNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Parameter nicht gefunden </code></pre></div><blockquote><p><code>E_PERMISSION</code></p></blockquote> <div class="language- extra-class"><pre><code>Keine Erlaubnis </code></pre></div><blockquote><p><code>E_QUERY</code></p></blockquote> <div class="language- extra-class"><pre><code>Datenbankabfragefehler </code></pre></div><blockquote><p><code>E_RECOVERED</code></p></blockquote> <div class="language- extra-class"><pre><code>Die API hat einen Panikfehler. Gibt einen Fehler zurück, wenn ein Panikfehler vorliegt. Es bedeutet, dass Sie auf einen Fehler gestoßen sind, der lokalisiert und behoben werden muss. </code></pre></div><blockquote><p><code>E_SERVER</code></p></blockquote> <div class="language- extra-class"><pre><code>Serverfehler. Wenn es einen Fehler in der golang-Bibliotheksfunktion gibt, kehrt sie zurück. Das msg-Feld enthält den im Fehlerfall zurückgegebenen Text. Als Antwort auf jeden Befehl kann ein **E_SERVER**-Fehler auftreten. Wenn es aufgrund falscher Eingabeparameter auftritt, können Sie es in einen verwandten Fehler ändern. In einem anderen Fall meldet dieser Fehler einen ungültigen Betrieb oder eine falsche Systemkonfiguration, was einen detaillierteren Untersuchungsbericht erfordert. </code></pre></div><blockquote><p><code>E_SIGNATURE</code></p></blockquote> <div class="language- extra-class"><pre><code>Falsche Signatur </code></pre></div><blockquote><p><code>E_STATELOGIN</code></p></blockquote> <div class="language- extra-class"><pre><code>`%s` ist kein Mitglied des Ökosystems `%s` </code></pre></div><blockquote><p><code>E_TABLENOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Tabelle `%s` nicht gefunden </code></pre></div><blockquote><p><code>E_TOKENEXPIRED</code></p></blockquote> <div class="language- extra-class"><pre><code>Sitzung `%s` ist abgelaufen </code></pre></div><blockquote><p><code>E_UNAUTHORIZED</code></p></blockquote> <div class="language- extra-class"><pre><code>Unbefugt. Wenn Sie nicht angemeldet sind oder die Sitzung abgelaufen ist, gibt jeder Befehl außer `getuid, login` einen E_UNAUTHORIZED-Fehler zurück. </code></pre></div><blockquote><p><code>E_UNKNOWNUID</code></p></blockquote> <div class="language- extra-class"><pre><code>Unbekannte UID </code></pre></div><blockquote><p><code>E_UPDATING</code></p></blockquote> <div class="language- extra-class"><pre><code>Der Knoten aktualisiert die Blockchain </code></pre></div><blockquote><p><code>E_STOPPING</code></p></blockquote> <div class="language- extra-class"><pre><code>Der Knoten wurde gestoppt </code></pre></div><blockquote><p><code>E_NOTIMPLEMENTED</code></p></blockquote> <div class="language- extra-class"><pre><code>Noch nicht implementiert </code></pre></div><blockquote><p><code>E_BANNED</code></p></blockquote> <div class="language- extra-class"><pre><code>Die Kontoadresse ist in `%s` verboten </code></pre></div><blockquote><p><code>E_CHECKROLE</code></p></blockquote> <div class="language- extra-class"><pre><code>Zugriff verweigert APIs sind für CLB nicht verfügbar </code></pre></div><hr> <blockquote><p>Schnittstellenanforderung für den CLB-Knoten nicht verfügbar:</p></blockquote> <ul><li>Metriken</li> <li>txinfo</li> <li>txinfoMultiple</li> <li>appparam</li> <li>appparams</li> <li>App-Inhalt</li> <li>Geschichte</li> <li>Balance</li> <li>Block</li> <li>maxblockid</li> <li>Blöcke</li> <li>detaillierte Blöcke</li> <li>Ökosystemparameter</li> <li>Systemparameter</li> <li>Ökosysteme</li> <li>Ökosystemparam</li> <li>Ökosystemname</li> <li>Brieftaschenverlauf</li> <li>tx_record</li></ul> <h2 id="request-type"><a href="#request-type" class="header-anchor">#</a> Request Type </h2> <p><strong>Uniform use</strong></p> <ul><li>application/x-www-form-urlencoded</li></ul> <h2 id="authentication-interface"><a href="#authentication-interface" class="header-anchor">#</a> Authentifizierung </h2> <p><a href="/de/reference/api2.html#https://jwt.io/">JWT-Token</a> wird zur Authentifizierung verwendet. Nach Erhalt des JWT-Tokens muss es in jedem Request-Header platziert werden: <code>Authorization: Bearer TOKEN_HERE</code>.</p> <h3 id="getuid"><a href="#getuid" class="header-anchor">#</a> getuid </h3> <p><strong>GET</strong>/ returns a unique value, signs it with the private key, and then uses The <a href="#login">login</a> command sends it back to the server.</p> <p>Generate a temporary JWT token that needs to be passed to <strong>Authorization</strong> when calling <strong>login</strong>.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/getuid </code></pre></div><p><strong>Response</strong></p> <ul><li><p><code>uid</code></p> <blockquote><p>Signature number.</p></blockquote></li> <li><p><code>token</code></p> <blockquote><p>The temporary token passed during login.</p> <p>The life cycle of a temporary token is 5 seconds.</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>Server identifier.</p></blockquote></li> <li><p><code>cryptoer</code></p> <blockquote><p>Elliptic curve algorithm.</p></blockquote></li> <li><p><code>hasher</code></p> <blockquote><p>hash algorithm.</p></blockquote></li></ul> <p><strong>Response Example 1</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json ```json { "uid": "4999317241855959593", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9....... .I7LY6XX4IP12En6nr8UPklE9U4qicqg3K9KEzGq_8zE" "network_id": "4717243765193692211" } </code></pre></div><p>In the case that no authorization is required (the request contains <strong>Authorization</strong>), the following message will be returned:</p> <ul><li><p><code>expire</code></p> <blockquote><p>Expiration time.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>Ecosystem ID.</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>Account address.</p></blockquote></li> <li><p><code>address</code></p> <blockquote><p>Wallet address <code>XXXX-XXXX-..... -XXXX</code>.</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>Server identifier.</p></blockquote></li></ul> <p><strong>Response Example 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>Error Response</strong></p> <p><em>E_SERVER</em></p> <h3 id="login"><a href="#login" class="header-anchor">#</a> Anmeldung </h3> <p>POST/ Authentifizierung der Benutzeridentität.</p> <p>Der Befehl <strong>getuid</strong> sollte zuerst aufgerufen werden, um einen eindeutigen Wert zu erhalten und ihn zu signieren. Das temporäre JWT-Token von getuid muss im Anforderungsheader übergeben werden.</p> <p>Wenn die Anfrage erfolgreich war, wird das in der Antwort erhaltene Token in <strong>Autorisierung</strong> aufgenommen. <strong>Anfrage</strong></p> <blockquote><p>POST /api/v2/login</p></blockquote> <ul><li><p><code>ecosystem</code></p> <p>Ökosystem-ID.</p> <p>Wenn nicht angegeben, ID des ersten Ökosystems standardmäßig.</p></li> <li><p><code>expire</code></p> <p>Lebensdauer des JWT-Tokens in Sekunden, standardmäßig 28800.</p></li> <li><p><code>pubkey</code></p> <p>Hexadezimaler öffentlicher Schlüssel des Kontos.</p></li> <li><p><code>key_id</code></p> <p>Kontoadresse <code>XXXX-...-XXXX</code>.</p> <p>Verwenden Sie diesen Parameter, wenn der öffentliche Schlüssel bereits in der Blockchain gespeichert ist. Es kann nicht gleichzeitig mit dem Pubkey-Parameter verwendet werden.</p></li> <li><p><code>signature</code></p> <p>UID-Signatur erhalten über getuid.</p></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>token</code></p> <p>JWT-Token.</p></li> <li><p><code>ecosystem_id</code></p> <p>Ökosystem-ID.</p></li> <li><p><code>key_id</code></p> <p>Kontoadressen-ID</p></li> <li><p><code>account</code></p> <p>Wallet-Adresse <code>XXXX-...-XXXX</code>.</p></li> <li><p><code>notify_key</code></p> <p>Benachrichtigungs-ID.</p></li> <li><p><code>isnode</code></p> <p>Ob die Kontoadresse der Besitzer des Knotens ist. Wert: <code>true, false</code>.</p></li> <li><p><code>isowner</code></p> <p>Ob die Kontoadresse der Ersteller des Ökosystems ist. Wert: <code>true, false</code>.</p></li> <li><p><code>clb</code></p> <p>Ob das registrierte Ökosystem CLB ist. Wert: <code>true, false</code>.</p></li> <li><p><code>roles</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Role list: <code>[{Role ID,Role Name}]</code>.</p></blockquote></li></ul> <p><strong>Response Example</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>Error Response</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> Dienstbefehle </h2> <h3 id="version"><a href="#version" class="header-anchor">#</a> Ausführung </h3> <p>GET/ Gibt die Version des aktuellen Servers zurück.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Anfrage</strong></p> <blockquote><p>GET /api/v2/version</p></blockquote> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/version </code></pre></div><p><strong>Response Example</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> Datenabfragefunktionen </h2> <h3 id="balance"><a href="#balance" class="header-anchor">#</a> Balance </h3> <p>GET/ Fordern Sie den Kontostand der Kontoadresse im aktuellen Ökosystem an.</p> <p><strong>Request</strong></p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/balance/{wallet} </code></pre></div><ul><li><code>wallet</code></li></ul> <p>Adresskennung. Sie können es in einem beliebigen Format <code>int64, uint64, XXXX-...-XXXX</code> angeben. Diese Adresse wird in dem Ökosystem abgefragt, in dem der Benutzer gerade angemeldet ist.</p> <h4 id=""><a href="#" class="header-anchor">#</a> Antwort</h4> <p><strong>Response</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>Response Example</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>Error Response</strong></p> <p><em>E_SERVER, E_INVALIDWALLET</em></p> <h3 id="blocks"><a href="#blocks" class="header-anchor">#</a> Blöcke </h3> <p>GET/ gibt eine Liste zurück, die zusätzliche Informationen zu Transaktionen in jedem Block enthält. Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</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> Default is 0</p> <blockquote><p>The height of the starting block to query.</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (default is 25, max request 1000)</p> <blockquote><p>Number of blocks.</p></blockquote></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>Block height</code></p> <blockquote><p>List of transactions in the block and additional information for each transaction.</p> <blockquote><ul><li><code>hash</code></li></ul> <blockquote><p>Trading Hash.</p></blockquote> <ul><li><code>contract_name</code></li></ul> <blockquote><p>Contract name.</p></blockquote> <ul><li><code>params</code></li></ul> <blockquote><p>Array of contract parameters.</p></blockquote> <ul><li><code>key_id</code></li></ul> <blockquote><p>For the first block, it is the account address of the first block that signed the transaction.</p></blockquote> <blockquote><p>For all other blocks, is the address of the account that signed the transaction.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Response Example</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>Error Response</strong></p> <p><em>E_SERVER, E_NOTFOUND</em></p> <h3 id="detailed-blocks"><a href="#detailed-blocks" class="header-anchor">#</a> detaillierte Blöcke </h3> <p>GET/ gibt eine Liste mit detaillierten zusätzlichen Informationen zu Transaktionen in jedem Block zurück.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</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> Default is 0</p> <blockquote><p>The height of the starting block to query.</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (default is 25, max request 1000)</p> <blockquote><p>Number of blocks.</p></blockquote></li></ul> <p><strong>Response</strong></p> <ul><li><code>Block height</code> The block height. <ul><li><code>blockhead</code> The block header contains the following fields. <ul><li><code>block_id</code> Block height.</li> <li><code>time</code> Block generation timestamp.</li> <li><code>key_id</code> Sign the account address for the block.</li> <li><code>node_position</code> The location of the node that generated the block in the honor node list.</li> <li><code>version</code> Block structure version.</li></ul></li> <li><code>hash</code> Block Hashing.</li> <li><code>node_position</code> the location of the node that generated the block in the honor node list.</li> <li><code>key_id</code> The address of the account that signed the block.</li> <li><code>time</code> Block generation timestamp.</li> <li><code>tx_count</code> Number of transactions within the block.</li> <li><code>size</code> The block size.</li> <li><code>rollback_hash</code> Block rollback hash.</li> <li><code>merkle_root</code> The block deals with the Merkle tree.</li> <li><code>bin_data</code> Serialization of the block header, all transactions within the block, the previous block hash, and the private key of the node that generated the block.</li> <li><code>transactions</code> List of transactions in the block and additional information about each transaction. <ul><li><code>hash</code> Trading hash.</li> <li><code>contract_name</code> Contract name.</li> <li><code>params</code> Contract parameters.</li> <li><code>key_id</code> Sign the account address for this transaction.</li> <li><code>time</code> Transaction generation timestamp.</li> <li><code>type</code> Transaction type.</li> <li><code>size</code> Trade Size.</li></ul></li></ul></li></ul> <p><strong>Response Example</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>Error Response</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>/ If the specified hash matching the data in the binary watch, field, and records, this request will return the data. Otherwise, return error.</p> <p>The request does not require login authorization.</p> <p><strong>Request</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>Record ID.</p></blockquote></li> <li><p><code>hash</code></p> <blockquote><p>Hash request data.</p></blockquote></li></ul> <p><strong>Response</strong></p> <blockquote><p>Binary data</p></blockquote> <p><strong>Response Example</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>Error Response</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>GET/ Wenn der angegebene Hash mit den Daten in der angegebenen Tabelle, dem angegebenen Feld und dem angegebenen Datensatz übereinstimmt, gibt diese Anforderung die Daten zurück. Andernfalls wird ein Fehler zurückgegeben.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</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> <p>Tabellenname.</p></li> <li><p><code>id</code></p> <p>Datensatz-ID.</p></li> <li><p><code>column</code></p> <p>Feldname.</p></li> <li><p><code>hash</code></p> <p>Hash der angeforderten Daten.</p></li></ul> <p><strong>Response</strong> Binärdaten</p> <p><strong>Response Example</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>Error Response</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>/ Return to a list of ecosystems, which contains the role of registered the specified address.</p> <p>The request does not require login authorization.</p> <p><strong>Request</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>Response</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>Ecosystem ID.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Ecosystem name.</p></blockquote></li> <li><p><code>roles</code></p> <blockquote><p>Activities with <em>id</em> and <em>name</em> fields.</p></blockquote></li></ul> <p><strong>Response Example</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>Error Response</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>/ Return to the current account transaction history record, find it according to the ID of the ID</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Request</strong></p> <ul><li><p><code>searchType</code></p> <blockquote><p>Find Type (Income: Turn into Outcom: Turn out all: All, default).</p></blockquote></li> <li><p><code>page</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Find the number of pages, the first page default, min: 1</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Credit number, default 20 articles. min: 1, MAX: 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>Response</strong></p> <ul><li><p><code>total</code></p> <blockquote><p>Total number of entries.</p></blockquote></li> <li><p><code>page</code></p> <blockquote><p>Number of current page.</p></blockquote></li> <li><p><code>limit</code></p> <blockquote><p>Currently find the number of bars.</p></blockquote></li> <li><p><code>list</code> Each element in the array contains the following parameters:</p> <ul><li><code>id</code> Stripe ID.</li> <li><code>sender_id</code> Send key_id</li> <li><code>sender_add</code> Send the account address</li> <li><code>recipient_id</code> Accept key_id</li> <li><code>recipient_add</code> Accept the account address</li> <li><code>amount</code> Transaction amount</li> <li><code>comment</code> Trading remarks</li> <li><code>block_id</code> Block height</li> <li><code>tx_hash</code> Trading hash</li> <li><code>created_at</code> Transaction creation time, millisecond time stamp</li> <li><code>money</code> Transaction amount</li></ul></li></ul> <p><strong>Response Example</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>Error Response</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>/ Return to the entry of the data table specified in the current ecosystem. You can specify columns to be returned.</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Data table name.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Credit number, default 25.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Disposal, default to 0.</p></blockquote></li> <li><p><code>order</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Sorting method, default <code>id ASC</code>.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>The list of request columns is separated by commas. If it is not specified, all columns will be returned. In all cases, the <code>id</code> column will be returned.</p></blockquote></li> <li><p><code>where</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Query condition</p> <p>Example: If you want to query id> 2 and name = john</p> <p>You can use: where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}</p> <p>For details, please refer to [DBFind](../ topics/script.md#dbfind) where syntax</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/listWhere/mytable </code></pre></div><p><strong>Response</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Total number of entries.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Each element in the array contains the following parameters:</p></blockquote> <ul><li><code>id</code> <blockquote><p>Stripe ID.</p></blockquote></li> <li><code>...</code> <blockquote><p>Data tables other columns</p></blockquote></li></ul></li></ul> <p><strong>Response Example</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>Error Response</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>/ Return to the specified data table. You can specify columns to be returned. The type in the data table is <strong>BYTEA</strong> Do hexadecimal encoding processing</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Data table name.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Credit number, default 25.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Disposal, default to 0.</p></blockquote></li> <li><p><code>order</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Sorting method, default <code>id ASC</code>.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>The list of request columns is separated by commas. If it is not specified, all columns will be returned. In all cases, the <code>id</code> column will be returned.</p></blockquote></li> <li><p><code>where</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Query condition</p> <p>Example: If you want to query id> 2 and name = john</p> <p>You can use: where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}</p> <p>For details, please refer to [DBFind](../ topics/script.md#dbfind) where syntax</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>Response</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Total number of entries.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Each element in the array contains the following parameters:</p></blockquote> <ul><li><code>id</code> <blockquote><p>Stripe ID.</p></blockquote></li> <li><code>...</code> <blockquote><p>Data tables other columns</p></blockquote></li></ul></li></ul> <p><strong>Response Example</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>Error Response</strong></p> <p><em>E_SERVER</em>,<em>E_TABLENOTFOUND</em></p> <h2 id="-2"><a href="#-2" 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>/ Returns the number of ecosystem 1 account addresses.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/keys </code></pre></div><p><strong>Response Example</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>/ Returns the number of blocks.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/blocks </code></pre></div><p><strong>Response Example</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>/ Returns the total number of transactions.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/transactions </code></pre></div><p><strong>Response Example</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>/ Returns the number of ecosystems.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/ecosystems </code></pre></div><p><strong>Response Example</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>/ Returns the number of honor nodes.</p> <p>This request does not require login authorization.</p> <div class="language- extra-class"><pre class="language-text"><code>GET /api/v2/metrics/honornodes </code></pre></div><p><strong>Response Example</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>/ Returns the name of the ecosystem by its identifier.</p> <p>This request does not require login authorization.</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>Ecosystem ID.</p></blockquote></li></ul> <p><strong>Response Example</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>Error Response</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>/ Returns a list of application parameters in the current or specified ecosystem.</p> <p><strong>Request</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>Application ID.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>Ecosystem ID; if not specified, the current ecosystem parameter will be returned.</p></blockquote></li> <li><p><code>names</code></p> <blockquote><p>The list of received parameters.</p> <p>You can specify a comma-separated list of parameter names, for example:<code>/api/v2/appparams/1?names=name,mypar</code>.</p></blockquote></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>Each element of the array contains the following parameters.</p> <ul><li><code>name</code>, the name of the parameter.</li> <li><code>value</code>, the value of the parameter.</li> <li><code>conditions</code>, change the permissions of the parameters.</li></ul></blockquote></li></ul> <p><strong>Response Example</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>Error Response</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>GET/ Gibt Informationen zurück, die sich auf den Parameter {name} der Anwendung {appid} im aktuellen oder angegebenen Ökosystem beziehen. <strong>Anfrage</strong></p> <blockquote><p>GET /api/v2/appparam/{appid}/{name}[?ecosystem=1]</p></blockquote> <ul><li><p><code>appid</code></p> <p>Anwendung ID.</p></li> <li><p><code>name</code></p> <p>Name des angeforderten Parameters.</p></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p></li></ul> <p>Ökosystem-ID (optionaler Parameter). Gibt standardmäßig das aktuelle Ökosystem zurück.</p> <p><strong>Response</strong></p> <ul><li><p>Ich würde</p> <p>Parameter-ID.</p></li> <li><p>Name</p> <p>Parametername.</p></li> <li><p>Wert</p> <p>Parameterwert.</p></li> <li><p>Bedingungen</p> <p>Berechtigung zum Ändern von Parametern.</p></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK) Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"10"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"par"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"My value"</span><span class="token punctuation">,</span> <span class="token property">"conditions"</span><span class="token operator">:</span> <span class="token string">"true"</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</strong> E_ECOSYSTEM, E_PARAMNOTFOUND</p> <h3 id="ecosystemparams"><a href="#ecosystemparams" class="header-anchor">#</a> Ökosystemparam </h3> <p><a href="#authorization">Authorization</a> GET/ Gibt die Liste der Ökosystemparameter zurück.</p> <p><strong>Request</strong></p> <blockquote><p>GET /api/v2/ecosystemparams/[?ecosystem=...&names=...]</p></blockquote> <ul><li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <p>Ökosystem-ID. Wenn nicht angegeben, wird die aktuelle Ökosystem-ID zurückgegeben.</p></li> <li><p><code>names</code> <a href="#omitempty">Omitempty</a> Liste der Anforderungsparameter, durch Kommas getrennt.</p> <p>Zum Beispiel: <code>/api/v2/ecosystemparams/?names=name,currency,logo</code>.</p></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>list</code></p></li> <li><p><code>list</code></p> <blockquote><p>Each element of the array contains the following parameters.</p> <ul><li><code>name</code></li></ul> <blockquote><p>Parameter name.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Parameter value.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Change permissions for parameters.</p></blockquote></blockquote></li></ul> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Inhaltstyp: application/json ```json { "list": [{ "name": "name", "value": "MyState", "conditions": "true", }, { "name": "currency", "value": "MY", "conditions": "true", }, ] } </code></pre></div><p><strong>Error Response</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="ecosystemparam-name"><a href="#ecosystemparam-name" class="header-anchor">#</a> ecosystemparam/{name} </h3> <p>GET/ Gibt Informationen zum Parameter {Name} im aktuellen oder angegebenen Ökosystem zurück.</p> <p><strong>Request</strong></p> <blockquote><p>GET /api/v2/ecosystemparam/{name}[?ecosystem=1]</p></blockquote> <ul><li><p><code>name</code></p> <p>Name des Anforderungsparameters.</p></li> <li><p><code>ecosystem</code></p> <p>Sie können die Ökosystem-ID angeben. Standardmäßig wird die aktuelle Ökosystem-ID zurückgegeben.</p></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>name</code></p> <p>Parametername.</p></li> <li><p><code>value</code></p> <p>Parameterwert.</p></li> <li><p><code>conditions</code></p> <p>Berechtigung zum Ändern der Parameter.</p></li></ul> <p><strong>Response Example</strong> 200 (OK) Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"currency"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"MYCUR"</span><span class="token punctuation">,</span> <span class="token property">"conditions"</span><span class="token operator">:</span> <span class="token string">"true"</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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>GET/ Gibt die Liste der Tabellen des aktuellen Ökosystems zurück, in der Sie den Offset und die Anzahl der Einträge festlegen können.</p> <p><strong>Request</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <p>Anzahl der Einträge, standardmäßig 25.</p></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <p>Offset, standardmäßig 0.</p></li></ul> <blockquote><p>GET /api/v2/tables</p></blockquote> <h4 id="-3"><a href="#-3" class="header-anchor">#</a> Antwort</h4> <ul><li><p><code>count</code></p> <p>Gesamteinträge in der Tabelle.</p> <ul><li><p><code>list</code></p> <p>Jedes Element im Array enthält die folgenden Parameter:</p></li></ul> <ul><li><p>name</p> <p>Tabellenname ohne Präfix.</p></li> <li><p>count</p> <p>Anzahl der Einträge in der Tabelle.</p></li></ul></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"count"</span><span class="token operator">:</span> <span class="token string">"100"</span><span class="token punctuation">,</span> <span class="token property">"list"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"accounts"</span><span class="token punctuation">,</span> <span class="token property">"count"</span><span class="token operator">:</span> <span class="token string">"10"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"citizens"</span><span class="token punctuation">,</span> <span class="token property">"count"</span><span class="token operator">:</span> <span class="token string">"5"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </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>/ Returns information about the current ecosystem request data table.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Data table name.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/table/{table_name} </code></pre></div><p>Returns the following field information.</p> <ul><li><p><code>name</code></p> <p>Tabellenname ohne das Ökosystempräfix.</p></li></ul> <ul><li><p><code>insert</code></p> <p>Berechtigung zum Hinzufügen neuer Einträge.</p></li> <li><p><code>new_column</code></p> <p>Berechtigung zum Hinzufügen neuer Felder.</p></li> <li><p><code>update</code></p> <p>Berechtigung zum Ändern von Einträgen.</p></li> <li><p>conditions</p> <p>Berechtigung zum Ändern der Tabellenkonfiguration.</p></li> <li><p><code>columns</code></p> <blockquote><p>Array of field-related information.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Field name.</p></blockquote> <ul><li><code>type</code></li></ul> <blockquote><p>Field data type.</p></blockquote> <ul><li><code>perm</code></li></ul> <blockquote><p>Change the permissions for the field value.</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>/ Returns a list of the specified data table entries in the current ecosystem. You can set the offset and the number of entries.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Data table name.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Number of entries, default 25 entries.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Offset, default is 0.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>A comma-separated list of requested columns, if not specified, all columns will be returned. The id column will be returned in all cases.</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>Response</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Total number of entries.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Each element of the array contains the following parameters.</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>Entry ID.</p></blockquote> <ul><li>The sequence of request columns.</li></ul></blockquote></blockquote></li></ul> <p><strong>Response Example</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>/ Returns the <em>sections</em> of the current ecosystem List of table entries, you can set the offset and the number of entries.</p> <p>If <em>role_access</em> field contains a list of roles and does not include the current role, no record will be returned. <em>title</em> The data in the field will be replaced by the <em>Accept-Language</em> language resource in the request header.</p> <p><strong>Request</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Number of entries, default 25 entries.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Offset, default is 0.</p></blockquote></li> <li><p><code>lang</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>This field specifies the multilingual resource code or localization, e.g., <em>en, de</em>. If the specified multilingual resource is not found, e.g., <em>en-US</em>, then the multilingual resource group in Search in <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>Response</strong></p> <ul><li><p><code>count</code></p> <blockquote><p><em>sections</em> Total number of table entries.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Each element of the array contains information about all columns in the actions table.</p></blockquote></li></ul> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Inhaltstyp: application/json { "count": "2", "list": [{ "id": "1", "title": "Development", "urlpage": "develop", ... }, ] } </code></pre></div><p><strong>Error Response</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>GET/ Gibt den Eintrag der angegebenen Tabelle im aktuellen Ökosystem zurück. Sie können die zurückzugebende(n) Spalte(n) angeben.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <p>Tabellenname.</p></li> <li><p><code>id</code></p> <p>Eintrags-ID.</p></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <p>Liste der angeforderten Spalten, getrennt durch Kommas. Wenn nicht angegeben, werden alle Spalten zurückgegeben. In allen Fällen wird die ID-Spalte zurückgegeben.</p></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>Response</strong></p> <ul><li><p><code>value</code></p> <p>Ein Array von Werten der angeforderten Spalten</p> <ul><li><p>id Eintrags-ID.</p></li> <li><p>Reihenfolge der angeforderten Spalten.</p></li></ul></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"10"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"John"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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>/ Return to the entry of the data table specified in the current ecosystem. You can specify columns to be returned.</p> <p><strong>Request</strong></p> <ul><li><p><code>Name</code></p> <blockquote><p>Data table name.</p></blockquote></li> <li><p><code>colorn</code></p> <blockquote><p>Data list name.</p></blockquote></li> <li><p><code>ID</code></p> <blockquote><p>Stripe ID.</p></blockquote></li> <li><p><code>columns</code> [omitempty] (#omitempty)</p> <blockquote><p>The list of request lists is separated by commas. If it is not specified, all columns will be returned. In all cases, the ID column will be returned.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /API/V2/ROW/MyTable/name/John? Columns = name `` ` **Response** - `Value` > Array of receiving column values Forecast > - `ID` >> >>> Strip ID. >> > - -The sequence of the request column. **Response Example** ```text 200 (OK) Content-type: Application/JSON {{ "Values": { "ID": "10", "name": "John", } } </code></pre></div><p><strong>Error Response</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>/ Returns a list of platform parameters.</p> <p><strong>Request</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>A list of request parameters, separated by commas. For example <code>/api/v2/systemparams/?names=max_columns,max_indexes</code>.</p></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>Each element of the array contains the following parameters.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Parameter name.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Parameter values.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Change the permission of the parameter.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Inhaltstyp: application/json ```json { "list": [{ "name": "max_columns", "value": "100", "conditions": "ContractAccess("@1UpdateSysParam")", }, { "name": "max_indexes", "value": "1", "conditions": "ContractAccess("@1UpdateSysParam")", }, ] } </code></pre></div><p><strong>Error Response</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>/ Returns the change record for the entry in the specified data table in the current ecosystem.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/history?name=contracts&id=5 </code></pre></div><blockquote><ul><li><code>name</code></li></ul> <p>Data Table Name.</p> <ul><li><code>id</code></li></ul> <blockquote><p>Entry ID.</p></blockquote></blockquote> <p><strong>Response</strong></p> <blockquote><ul><li><code>list</code></li></ul> <p>Each element of the array contains a change record for the requested entry.</p></blockquote> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Inhaltstyp: application/json ```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>/ Returns the current ecosystem in the specified data table (pages, menu or snippet) <em>name</em> The entry for the field.</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>Request</strong></p> <ul><li><p><code>name</code></p> <p>Name des in der Tabelle angegebenen Eintrags.</p></li></ul> <h4 id="-4"><a href="#-4" class="header-anchor">#</a> Antwort</h4> <ul><li><p><code>id</code></p> <p>Eintrags-ID.</p></li> <li><p><code>name</code></p> <p>Eintragsname.</p></li> <li><p><code>other</code></p> <p>Andere Spalten der Tabelle.</p></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"1"</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"default_page"</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"P(Page content)"</span><span class="token punctuation">,</span> <span class="token property">"default_menu"</span><span class="token operator">:</span> <span class="token string">"default_menu"</span><span class="token punctuation">,</span> <span class="token property">"validate_count"</span><span class="token operator">:</span> <span class="token number">1</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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> Vertragsfunktionen </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> GET/ Gibt die Liste der Verträge im aktuellen Ökosystem zurück und kann den Offset und die Anzahl der Einträge festlegen.</p> <p><strong>Request</strong></p> <ul><li><p><code>limit</code></p> <p>Anzahl der Einträge, standardmäßig 25.</p></li> <li><p><code>offset</code></p> <p>Offset, standardmäßig 0.</p></li></ul> <blockquote><p>GET /api/v2/contracts</p></blockquote> <p><strong>Response</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Total number of entries.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Each element of the array contains the following parameters.</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>Contract ID.</p></blockquote> <ul><li><code>name</code></li></ul> <blockquote><p>Contract name.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Contract contents.</p></blockquote> <ul><li><code>wallet_id</code></li></ul> <blockquote><p>The account address to which the contract is tied.</p></blockquote> <ul><li><code>address</code></li></ul> <blockquote><p>Contract-bound wallet address <code>XXXX-... -XXXX</code>.</p></blockquote> <ul><li><code>ecosystem_id</code></li></ul> <blockquote><p>The ecosystem ID to which the contract belongs.</p></blockquote> <ul><li><code>app_id</code></li></ul> <blockquote><p>The application ID to which the contract belongs.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Change the permission of the contract.</p></blockquote> <ul><li><code>token_id</code></li></ul> <blockquote><p>The ID of the ecosystem where the pass is used to pay the contract fee.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-text extra-class"><pre class="language-text"><code> { "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", "conditions":"ContractConditions(`MainCondition`)" }, ... ] } </code></pre></div><h3 id="contract-name"><a href="#contract-name" class="header-anchor">#</a> contract/{name} </h3> <p>GET/ Gibt die relevanten Informationen des angegebenen Vertrags zurück. Standardmäßig wird der Vertrag im aktuellen Ökosystem abgefragt.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></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>Response</strong></p> <ul><li><p><code>id</code></p> <p>Vertrags-ID in VM.</p></li></ul> <ul><li><p><code>name</code></p> <p>Vertragsname „@1MainCondition“ mit der Ökosystem-ID.</p></li> <li><p><code>state</code></p> <p>ID des Ökosystems, zu dem der Vertrag gehört.</p></li> <li><p><code>walletid</code></p> <p>An den Vertrag gebundene Kontoadresse.</p></li> <li><p><code>tokenid</code></p> <p>Als ID des Ökosystems, in dem sich der Token befindet, der zur Zahlung der Vertragsgebühr verwendet wird.</p></li> <li><p><code>address</code></p> <p>An den Vertrag gebundene Wallet-Adresse <code>XXXX-...-XXXX</code>.</p></li> <li><p><code>tableid</code></p> <p>Eintrags-ID des Vertrags in der Vertragstabelle.</p></li> <li><p><code>fields</code></p> <blockquote><p>The array contains structural information for each parameter of the contract <strong>data</strong> section.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Parameter name.</p></blockquote> <ul><li></li></ul> <p><code>type</code></p> <p>Parameter type.</p> <ul><li><code>optional</code></li></ul> <blockquote><p>Parameter options, `true` means optional parameters, `false` means mandatory parameters.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"fields"</span> <span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span><span class="token property">"name"</span><span class="token operator">:</span><span class="token string">"amount"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span><span class="token string">"int"</span><span class="token punctuation">,</span> <span class="token property">"optional"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token property">"name"</span><span class="token operator">:</span><span class="token string">"name"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span><span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"optional"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token number">150</span><span class="token punctuation">,</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"@1mycontract"</span><span class="token punctuation">,</span> <span class="token property">"tableid"</span> <span class="token operator">:</span> <span class="token number">10</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</strong></p> <p><em>E_CONTRACT</em></p> <h3 id="sendtx"><a href="#sendtx" class="header-anchor">#</a> sendTX </h3> <p>POST/ Empfangen Sie die Transaktion im Parameter und fügen Sie sie der Transaktionswarteschlange hinzu. Wenn die Anfrage erfolgreich ausgeführt wird, wird der Transaktions-Hash zurückgegeben. Mit dem Hash erhalten Sie die entsprechende Transaktion im Block. Wenn eine Fehlerantwort auftritt, wird der Hash in die Fehlertextnachricht eingefügt.</p> <p><strong>Request</strong></p> <ul><li><code>tx_key</code></li></ul> <blockquote><p>Transaktionsinhalt. Sie können einen beliebigen Namen angeben und unterstützen den Empfang mehrerer Transaktionen mit diesem Parameter. POST /api/v2/sendTx</p></blockquote> <div class="language- extra-class"><pre class="language-text"><code>Headers: Content-Type: multipart/form-data Parameters: tx1 - transaction 1 txN - transaction N </code></pre></div><p><strong>Response</strong></p> <ul><li><p><code>hashes</code></p> <blockquote><p>Transaction hash arrays.</p> <blockquote><ul><li><code>tx1</code></li></ul> <blockquote><p>Trading 1 hash.</p></blockquote> <ul><li><code>txN</code></li></ul> <blockquote><p>Trading N's hash.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK) Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"hashes"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"tx1"</span><span class="token operator">:</span> <span class="token string">"67afbc435634....."</span><span class="token punctuation">,</span> <span class="token property">"txN"</span><span class="token operator">:</span> <span class="token string">"89ce4498eaf7....."</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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>/ Returns the block ID and error message for the specified transaction hash. If the return values for the block ID and error text message are null, then the transaction is not yet contained in the block.</p> <p><strong>Request</strong></p> <ul><li><p><code>data</code></p> <blockquote><p>JSON list of transaction hashes.</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>Response</strong></p> <ul><li><p><code>results</code></p> <blockquote><p>The transaction hash is used as the key and the transaction detail is used as the value in the data dictionary.</p> <p><code>hash</code></p> <blockquote><p>Trading Hash.</p> <ul><li><code>blockid</code></li></ul> <p>If the transaction execution succeeds, the block ID is returned; if the transaction execution fails, the</p> <blockquote><p><code>blockid</code> for [0]{.title-ref}.</p></blockquote> <ul><li><code>result</code></li></ul> <blockquote><p>Returns the result of the transaction via the <strong>$result</strong> variable.</p></blockquote> <ul><li><code>errmsg</code></li></ul> <p>Returns an error text message if the execution of the transaction fails.</p></blockquote></blockquote></li></ul> <p><strong>Response Example</strong> 200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span><span class="token property">"results"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"hash1"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"blockid"</span><span class="token operator">:</span> <span class="token string">"3123"</span><span class="token punctuation">,</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"hash2"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"blockid"</span><span class="token operator">:</span> <span class="token string">"3124"</span><span class="token punctuation">,</span> <span class="token property">"result"</span><span class="token operator">:</span> <span class="token string">""</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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>GET/ Gibt die Informationen des angegebenen Hashs zurück, die mit der Transaktion korrelieren, einschließlich der Block-ID und der Anzahl der Bestätigungen. Wenn optionale Parameter angegeben werden, können auch der Vertragsname und zugehörige Parameter zurückgegeben werden.</p> <p><strong>Request</strong></p> <ul><li><p>hash</p> <p>Transaktionshash.</p></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p></li></ul> <p>Detaillierte Kennung des Vertragsparameters. Um Vertragsdetails zu erhalten, die sich auf die Transaktion beziehen, geben Sie <code>contractinfo=1</code> an.</p> <blockquote><p>GET /api/v2/txinfo/c7ef367b494c7ce855f09aa3f1f2af7402535ea627fa615ebd63d437db5d0c8a?contractinfo=1</p></blockquote> <h4 id="-5"><a href="#-5" class="header-anchor">#</a> Antwort</h4> <ul><li><p><code>blockid</code></p> <p>Enthält die Block-ID der Transaktion. Wenn der Wert <code>0</code> ist, kann keine Transaktion mit diesem Hash gefunden werden.</p></li> <li><p><code>confirm</code></p> <p>Anzahl der Bestätigungen des Blocks blockid.</p></li> <li><p><code>data</code> <a href="#omitempty">Omitempty</a></p> <p>Wenn <code>contentinfo=1</code> angegeben ist, werden die Vertragsdetails an diesen Parameter zurückgegeben.</p></li></ul> <p><strong>Response Example</strong> 200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span> <span class="token property">"blockid"</span><span class="token operator">:</span> <span class="token string">"9"</span><span class="token punctuation">,</span> <span class="token property">"confirm"</span><span class="token operator">:</span> <span class="token number">11</span><span class="token punctuation">,</span> <span class="token property">"data"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"block"</span><span class="token operator">:</span> <span class="token string">"9"</span><span class="token punctuation">,</span> <span class="token property">"contract"</span><span class="token operator">:</span> <span class="token string">"@1NewContract"</span><span class="token punctuation">,</span> <span class="token property">"params"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"ApplicationId"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"Conditions"</span><span class="token operator">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span> <span class="token property">"Value"</span><span class="token operator">:</span> <span class="token string">"contract crashci4b {\n\t\t\tdata {}\n\t\t}"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</strong></p> <p><em>E_HASHWRONG</em></p> <h3 id="txinfomultiple"><a href="#txinfomultiple" class="header-anchor">#</a> txinfoMultiple </h3> <p>GET/ Gibt die Informationen des angegebenen Hashs zurück, die mit einer Transaktion korrelieren.</p> <p><strong>Request</strong></p> <ul><li><p><code>data</code></p> <ul><li><code>hashes</code></li></ul> <blockquote><p>A list of transaction hashes.</p></blockquote></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Detaillierte Kennung des Vertragsparameters. Um Vertragsdetails in Bezug auf die Transaktion zu erhalten, geben Sie <code>contractinfo=1</code> an.</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>Response</strong></p> <ul><li><p><code>results</code></p> <p>Im Datenwörterbuch Transaktions-Hashes als Schlüssel und Transaktionsdetails als Wert.</p> <ul><li>hash</li></ul> <p>Transaktionshash.</p> <ul><li>blockid</li></ul> <p>Block-ID, die die Transaktion enthält. Wenn der Wert <code>0</code> ist, kann keine Transaktion mit diesem Hash gefunden werden.</p> <ul><li>confirm</li></ul> <p>Anzahl der Bestätigungen des Blocks blockid.</p> <ul><li>date</li></ul> <p>Wenn <code>contentinfo=1</code> angegeben ist, werden die Vertragsdetails an diesen Parameter zurückgegeben.</p></li></ul> <p><strong>Response Example</strong></p> <p>200 (OK)</p> <p>Inhaltstyp: application/json</p> <div class="language-json extra-class"><pre class="language-json"><code><span class="token punctuation">{</span><span class="token property">"results"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"hash1"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"blockid"</span><span class="token operator">:</span> <span class="token string">"3123"</span><span class="token punctuation">,</span> <span class="token property">"confirm"</span><span class="token operator">:</span> <span class="token string">"5"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"hash2"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"blockid"</span><span class="token operator">:</span> <span class="token string">"3124"</span><span class="token punctuation">,</span> <span class="token property">"confirm"</span><span class="token operator">:</span> <span class="token string">"3"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p><strong>Error Response</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>GET/ Gibt die Anzahl der Knoten zurück, die zum Überprüfen der angegebenen Seite erforderlich sind.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Page name with ecosystem ID in the format <code>@ecosystem_id%%page_name%</code>, for example <code>@1main_page</code>. If you don't have an ecosystem ID, then search in the first ecosystem page by default</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>Response</strong></p> <ul><li><p><code>validate_count</code></p> <blockquote><p>Specifies the number of nodes to be validated for the page.</p></blockquote></li></ul> <p><strong>Response Example</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>Error Response</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> POST/ Gibt den JSON-Objektbaum des Codes der angegebenen Seite oder des Menünamens zurück, der das Ergebnis der Vorlagen-Engine-Verarbeitung ist.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <p>Seiten- oder Menüname. `` text POST /api/v2/content/page/default</p></li></ul> <div class="language- extra-class"><pre class="language-text"><code> **Response** - `menu` || `title` Menüname der Seite bei Anforderung von Inhalt/Seite/… - `menutree` Ein JSON-Objektbaum des Seitenmenüs beim Anfordern von Inhalt/Seite/… - `title` --head for the menu *content/menu/\...* Menüname bei Anforderung von Inhalt/Menü/... - `tree` Ein JSON-Objektbaum einer Seite oder eines Menüs. **Response Example** 200 (OK) Inhaltstyp: application/json ```json { "tree": {"type":"......", "children": [ {...}, {...} ] }, } </code></pre></div><p><strong>Error Response</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>Returns a tree of coded JSON objects for the specified page name. Does not execute any functions or receive any data. The returned JSON object tree corresponds to the page template and can be used in the visual page designer. If the page is not found, a 404 error is returned.</p> <p><strong>Request</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Page name with ecosystem ID in the format <code>@ecosystem_id%%page_name%</code>, for example <code>@1main_page</code>. If no ecosystem ID is included, then search for the current eco-page by default.</p></blockquote></li></ul> <p><strong>Response</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>Response Example</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>Error Response</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>Returns a SHA256 hash of the specified page name, or a 404 error if the page cannot be found.</p> <p>This request does not require login authorization. To receive the correct hash when making requests to other nodes, you must also pass <em>ecosystem,keyID,roleID,isMobile</em> parameter. To receive pages from other ecosystems, the ecosystem ID must be prefixed to the page name. For example: <code>@2mypage</code>.</p> <p><strong>Request</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> <p>Seitenname mit der Ökosystem-ID.</p></li> <li><p><code>ecosystem</code></p> <p>Ökosystem-ID.</p></li> <li><p><code>keyID</code></p> <p>Kontoadresse.</p></li> <li><p><code>roleID</code></p> <p>Rollen-ID.</p></li></ul> <p><strong>Response</strong></p> <ul><li><p><code>hash</code></p> <p>Hexadezimaler Hash.</p></li></ul> <p><strong>Response Example</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>Error Response</strong></p> <p><em>E_NOTFOUND, E_SERVER, E_HEAVYPAGE</em> E_NOTFOUND, E_SERVER, E_HEAVYPAGE</p> <h3 id="content"><a href="#content" class="header-anchor">#</a> Inhalt </h3> <p><strong>POST</strong></p> <p>Returns the number of JSON objects for the page code from the <strong>template</strong> parameter, if the optional parameter <strong>source</strong> is specified as <code>true or 1</code>, then this JSON object tree does not perform any functions and receive data. This JSON object tree can be used in the visual page designer.</p> <p>This request does not require login authorization.</p> <p><strong>Request</strong></p> <ul><li><p><code>template</code></p> <blockquote><p>Page code.</p></blockquote></li> <li><p><code>source</code></p> <blockquote><p>If <code>true or 1</code> is specified, the JSON object tree does not perform any functions and receives data.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content </code></pre></div><p><strong>Response</strong></p> <ul><li><p><code>tree</code></p> <blockquote><p>JSON object tree.</p></blockquote></li></ul> <p><strong>Response Example</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>Error Response</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="maxblockid"><a href="#maxblockid" class="header-anchor">#</a> maxblockid </h3> <p>GET/ Gibt die ID des höchsten Blocks auf dem aktuellen Knoten zurück.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</strong></p> <blockquote><p>GET /api/v2/maxblockid</p></blockquote> <p><strong>Response</strong></p> <ul><li><code>max_block_id</code></li></ul> <p>ID des höchsten Blocks auf dem aktuellen Knoten.</p> <p><strong>Response Example</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>Error Response</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="block-id"><a href="#block-id" class="header-anchor">#</a> block/{id} </h3> <p>GET/ Gibt relevante Informationen des Blocks mit der angegebenen ID zurück.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</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>Response</strong></p> <ul><li><p><code>hash</code></p> <p>Hash des Blocks.</p></li> <li><p><code>key_id</code></p> <p>Adresse des Kontos, das den Block signiert hat.</p></li> <li><p><code>time</code></p> <p>Zeitstempel der Blockgenerierung.</p></li> <li><p><code>tx_count</code></p> <p>Gesamtzahl der Transaktionen im Block.</p></li> <li><p><code>rollbacks_hash</code></p> <p>Hash für Block-Rollback.</p></li> <li><p><code>node_position</code></p> <p>Position des Blocks in der Liste der Ehrenknoten.</p></li></ul> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Inhaltstyp: 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>Error Response</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>GET/ Gibt den Avatar des Benutzers in der Mitgliedertabelle zurück (Sie können ihn ohne Anmeldung verwenden).</p> <p><strong>Request</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>Ecosystem ID.</p></blockquote></li> <li><p><code>member</code></p> <blockquote><p>The user's account address. (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>Response</strong></p> <p>The request header <em>Content-Type</em> is the image type and the image data is returned in the response body.</p> <p><strong>Response Example</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: image/png </code></pre></div><p><strong>Error Response</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>/ Returns the host address and port of centrifugo.</p> <p>This request does not require login authorization.</p> <p><strong>Request</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/config/centrifugo </code></pre></div><p><strong>Response</strong></p> <p>Response result format <code>http://address:port</code>, e.g.: <code>http://127.0.0.1:8100</code>.</p> <p><strong>Error Response</strong></p> <p><em>E_SERVER</em></p> <h3 id="updnotificator"><a href="#updnotificator" class="header-anchor">#</a> updnotificator </h3> <p>POST/ Senden Sie alle Nachrichten, die noch nicht gesendet wurden, an den Benachrichtigungsdienst von centrifugo. Senden Sie nur Nachrichten für bestimmte Ökosysteme und Mitglieder.</p> <p>Für diese Anfrage ist keine Anmeldeberechtigung erforderlich.</p> <p><strong>Request</strong></p> <ul><li><p><code>id</code></p> <p>Kontoadresse des Mitglieds.</p></li> <li><p><code>ecosystem</code></p> <p>Ecosystem ID.</p></li></ul> <blockquote><p>POST /api/v2/updnotificator</p></blockquote> <p><strong>Response Example</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>If the field has an omitempty attribute, it means that the field is an optional parameter</p> <h4 id="authorization"><a href="#authorization" class="header-anchor">#</a> Authorization </h4> <p>If the interface with Authorization tag, that this interface requires login authorization, add Authorization to the request header, example.</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/de/reference/api2.md" target="_blank" rel="noopener noreferrer">Bearbeiten Sie diese Seite auf 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">Letzte Aktualisierung:</span> <span class="time">6.7.2023, 18:59:03</span></div></footer> <div class="page-nav"><p class="inner"> <span class="next"><a href="/de/reference/platform-parameters.html"> Plattformparameter </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/20.8bca4a67.js" defer></script> </body> </html>