API RESTful v2 </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#error-response-handling" class="sidebar-link">Gestion des réponses d'erreur </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#error-list" class="sidebar-link">Liste d'erreurs </a></li></ul></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#request-type" class="sidebar-link">Type de demande </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#authentication-interface" class="sidebar-link">Interface d'authentification </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#getuid" class="sidebar-link">getuid </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#login" class="sidebar-link">login </a></li></ul></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#server-side-command-interface" class="sidebar-link">Interface de commande côté serveur </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#version" class="sidebar-link">version </a></li></ul></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#data-request-function-interface" class="sidebar-link">Data Request Function Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#balance" class="sidebar-link">balance </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#blocks" class="sidebar-link">blocks </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#detailed-blocks" class="sidebar-link">detailed_blocks </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#data-id-data-hash" class="sidebar-link">/data/{id}/data/{hash} </a></li><li class="sidebar-sub-header"><a href="/fr/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="/fr/reference/api2.html#keyinfo" class="sidebar-link">keyinfo </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#wallethistory" class="sidebar-link">walletHistory </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#listwhere-name" class="sidebar-link">listWhere/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#nodelistwhere-name" class="sidebar-link">nodelistWhere/{name} </a></li></ul></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#get-metrics-interface" class="sidebar-link">Obtenir l'interface des métriques </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#metrics-keys" class="sidebar-link">metrics/keys </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#metrics-blocks" class="sidebar-link">metrics/blocks </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#metrics-transactions" class="sidebar-link">metrics/transactions </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#metrics-ecosystems" class="sidebar-link">metrics/ecosystems </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#metrics-honornodes" class="sidebar-link">metrics/honornodes </a></li></ul></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#ecosystem-interface" class="sidebar-link">Interface de l'écosystème </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#ecosystemname" class="sidebar-link">ecosystemname </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#appparams-appid" class="sidebar-link">appparams/{appid} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#appparam-appid-name" class="sidebar-link">appparam/{appid}/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#ecosystemparams" class="sidebar-link">ecosystemparams </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#ecosystemparam-name" class="sidebar-link">ecosystemparam/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#tables-limit-offset" class="sidebar-link">tables/\[?limit=\... &offset=\... \] </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#table-name" class="sidebar-link">table/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/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="/fr/reference/api2.html#sections-limit-offset-lang" class="sidebar-link">sections\[?limit=\... &offset=\... &lang=\] </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#row-name-id-columns" class="sidebar-link">row/{name}/{id}\[?columns=\] </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#row-name-colorn-id" class="sidebar-link">row/{name}/{column}/{id} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#systemparams" class="sidebar-link">systemparams </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#history-name-id" class="sidebar-link">history/{name}/{id} </a></li><li class="sidebar-sub-header"><a href="/fr/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="/fr/reference/api2.html#contract-function-interface" class="sidebar-link">Contract Function Interface </a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#contracts-limit-offset" class="sidebar-link">contracts\[?limit=\... &offset=\... \] </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#contract-name" class="sidebar-link">contract/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#sendtx" class="sidebar-link">sendTX </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#txstatus" class="sidebar-link">txstatus </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#txinfo-hash" class="sidebar-link">txinfo/{hash} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#txinfomultiple" class="sidebar-link">txinfoMultiple </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#page-validators-count-name" class="sidebar-link">/page/validators_count/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#content-menu-page-name" class="sidebar-link">content/menu\|page/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#content-source-name" class="sidebar-link">content/source/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#content-hash-name" class="sidebar-link">content/hash/{name} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#content" class="sidebar-link">content </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#maxblockid" class="sidebar-link">maxblockid </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#block-id" class="sidebar-link">block/{id} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#avatar-ecosystem-member" class="sidebar-link">avatar/{ecosystem}/{member} </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#config-centrifugo" class="sidebar-link">config/centrifugo </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#updnotificator" class="sidebar-link">updnotificator </a></li><li class="sidebar-sub-header"><a href="/fr/reference/api2.html#special-instructions" class="sidebar-link">Instructions spéciales </a></li></ul></li></ul></li><li><a href="/fr/reference/platform-parameters.html" class="sidebar-link">Paramètres de la plateforme </a></li><li><a href="/fr/reference/backend-config.html" class="sidebar-link">Fichier de configuration du serveur </a></li><li><a href="/fr/reference/desync_monitor.html" class="sidebar-link">Outil de surveillance synchronisée </a></li><li><a href="/fr/reference/json-rpc.html" class="sidebar-link">Interface de programmation d'application JSON-RPC </a></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="restful-api-v2"><a href="#restful-api-v2" class="header-anchor">#</a> API RESTful v2 </h1> <p><strong>Weaver</strong></p> <p>Toutes les fonctions fournies, y compris l'authentification, la réception des données de l'écosystème, la gestion des erreurs, la manipulation des tables de la base de données, l'exécution des pages et des contrats sont disponibles via l'API REST de la plateforme IBAX Blockchain.</p> <p>En utilisant l'API REST, les développeurs peuvent accéder à toutes les fonctionnalités de la plateforme sans utiliser Weaver.</p> <p>Les appels de commandes API sont exécutés en adressant <code>/api/v2/commande/[param]</code>, où <code>commande</code> est le nom de la commande et <code>param</code> est le paramètre supplémentaire. Les paramètres de la requête doivent être spécifiés en utilisant le <code>Content-Type: x-www-form-urlencoded</code>.</p> <p>Le format est envoyé. La réponse du serveur est renvoyée au format JSON.</p> <ul><li><a href="#error-response-handling">Gestion des réponses d'erreur</a> <ul><li><a href="#error-list">Liste d'erreurs</a></li></ul></li> <li><a href="#request-type">Type de requête</a></li> <li><a href="#authentication-interface">Interface d'authentification</a> <ul><li><a href="#getuid">getuid</a></li> <li><a href="#login">login</a></li></ul></li> <li><a href="#server-side-command-interface">Interface de commande côté serveur</a> <ul><li><a href="#version">version</a></li></ul></li> <li><a href="#data-request-function-interface">Interface de fonction de demande de données</a> <ul><li><a href="#balance">balance</a></li> <li><a href="#blocks">blocks</a></li> <li><a href="#detailed-blocks">detailed_blocks</a></li> <li><a href="#data-id-data-hash">/data/{id}/data/{hash}</a></li> <li><a href="#data-table-id-column-hash">/data/{table}/id/{column}/{hash}</a></li> <li><a href="#keyinfo">keyinfo</a></li> <li><a href="#wallethistory">walletHistory</a></li> <li><a href="#listwhere-name">listWhere/{name}</a></li> <li><a href="#nodelistwhere-name">nodelistWhere/{name}</a></li></ul></li> <li><a href="#get-metrics-interface">Interface de récupération des métriques</a> <ul><li><a href="#metrics-keys">metrics/keys</a></li> <li><a href="#metrics-blocks">metrics/blocks</a></li> <li><a href="#metrics-transactions">metrics/transactions</a></li> <li><a href="#metrics-ecosystems">metrics/ecosystems</a></li> <li><a href="#metrics-honornodes">metrics/honornodes</a></li></ul></li> <li><a href="#ecosystem-interface">Interface de l'écosystème</a> <ul><li><a href="#ecosystemname">ecosystemname</a></li> <li><a href="#appparams-appid">appparams/{appID}</a></li> <li><a href="#appparam-appid-name">appparam/{appid}/{name}</a></li> <li><a href="#ecosystemparams">ecosystemparams</a></li> <li><a href="#ecosystemparam-name">ecosystemparam/{name}</a></li> <li><a href="#tables-limit-offset">tables/[?limit=... &offset=... ]</a></li> <li><a href="#table-name">table/{name}</a></li> <li><a href="#list-name-limit-offset-columns">list/{name}[?limit=... &offset=... &columns=... ]</a></li> <li><a href="#sections-limit-offset-lang">sections[?limit=... &offset=... &lang=]</a></li> <li><a href="#row-name-id-columns">row/{name}/{id}[?columns=]</a></li> <li><a href="#row-name-column-id">row/{name}/{column}/{id}</a></li> <li><a href="#systemparams">systemparams</a></li> <li><a href="#history-name-id">history/{name}/{id}</a></li> <li><a href="#interface-page-menu-snippet-name">interface/{page|menu|snippet}/{name}</a></li></ul></li> <li><a href="#contract-function-interface">Interface de fonction de contrat</a> <ul><li><a href="#contracts-limit-offset">contracts[?limit=... &offset=... ]</a></li> <li><a href="#contract-name">contract/{name}</a></li> <li><a href="#sendtx">sendTX</a></li> <li><a href="#txstatus">txstatus</a></li> <li><a href="#txinfo-hash">txinfo/{hash}</a></li> <li><a href="#txinfomultiple">txinfoMultiple</a></li> <li><a href="#page-validators-count-name">/page/validators_count/{name}</a></li> <li><a href="#content-menu-page-name">content/menu|page/{name}</a></li> <li><a href="#content-source-name">content/source/{name}</a></li> <li><a href="#content-hash-name">content/hash/{name}</a></li> <li><a href="#content">content</a></li> <li><a href="#maxblockid">maxblockid</a></li> <li><a href="#block-id">block/{id}</a></li> <li><a href="#avatar-ecosystem-member">avatar/{ecosystem}/{member}</a></li> <li><a href="#config-centrifugo">config/centrifugo</a></li> <li><a href="#updnotificator">updnotificator</a></li></ul></li></ul> <h2 id="error-response-handling"><a href="#error-response-handling" class="header-anchor">#</a> Gestion des réponses d'erreur </h2> <p>Statut de retour en cas d'exécution réussie de la requête <code>200</code>. Si une erreur se produit, en plus du statut d'erreur, un objet JSON avec les champs suivants sera renvoyé.</p> <ul><li><p><strong>error</strong></p> <blockquote><p>Identifiant d'erreur.</p></blockquote></li> <li><p><strong>msg</strong></p> <blockquote><p>Message d'erreur.</p></blockquote></li> <li><p><strong>params</strong></p> <blockquote><p>Un tableau de paramètres supplémentaires pouvant être placés dans le message d'erreur.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>400 (Bad request) Content-Type: application/json { "err": "E_INVALIDWALLET", "msg": "Wallet 1234-5678-9012-3444-3488 is not valid", "params": ["1234-5678-9012-3444-3488"] } </code></pre></div><h3 id="error-list"><a href="#error-list" class="header-anchor">#</a> Liste d'erreurs </h3> <blockquote><p><code>E_CONTRACT</code></p></blockquote> <div class="language- extra-class"><pre><code>Aucun contrat `%s` n'existe </code></pre></div><blockquote><p><code>E_DBNIL</code></p></blockquote> <div class="language- extra-class"><pre><code>La base de données est vide </code></pre></div><blockquote><p><code>E_DELETEDKEY</code></p></blockquote> <div class="language- extra-class"><pre><code>L'adresse du compte est gelée </code></pre></div><blockquote><p><code>E_ECOSYSTEM</code></p></blockquote> <div class="language- extra-class"><pre><code>L'écosystème `%d` n'existe pas </code></pre></div><blockquote><p><code>E_EMPTYPUBLIC</code></p></blockquote> <div class="language- extra-class"><pre><code>Clé publique du compte invalide </code></pre></div><blockquote><p><code>E_KEYNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Adresse du compte introuvable </code></pre></div><blockquote><p><code>E_HASHWRONG</code></p></blockquote> <div class="language- extra-class"><pre><code>Hash incorrect </code></pre></div><blockquote><p><code>E_HASHNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Hash introuvable </code></pre></div><blockquote><p><code>E_HEAVYPAGE</code></p></blockquote> <div class="language- extra-class"><pre><code>Trop de chargement de page </code></pre></div><blockquote><p><code>E_INVALIDWALLET</code></p></blockquote> <div class="language- extra-class"><pre><code>Adresse du portefeuille `%s` invalide </code></pre></div><blockquote><p><code>E_LIMITTXSIZE</code></p></blockquote> <div class="language- extra-class"><pre><code>La taille de la transaction a dépassé la limite </code></pre></div><blockquote><p><code>E_NOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Page ou contenu du menu introuvable </code></pre></div><blockquote><p><code>E_PARAMNOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Paramètres introuvables </code></pre></div><blockquote><p><code>E_PERMISSION</code></p></blockquote> <div class="language- extra-class"><pre><code>Pas de permission </code></pre></div><blockquote><p><code>E_QUERY</code></p></blockquote> <div class="language- extra-class"><pre><code>Erreur de requête de base de données </code></pre></div><blockquote><p><code>E_RECOVERED</code></p></blockquote> <div class="language- extra-class"><pre><code>Une erreur de panique de l'API s'est produite. Si une erreur de panique se produit, une erreur est renvoyée. Cette erreur signifie que vous avez rencontré un bogue qui doit être identifié et corrigé. </code></pre></div><blockquote><p><code>E_SERVER</code></p></blockquote> <div class="language- extra-class"><pre><code>Erreur du serveur. Renvoyé s'il y a une erreur dans la fonction de la bibliothèque golang. Le champ \*msg\* contient le message d'erreur. **E_SERVER** peut apparaître en réponse à n'importe quelle erreur de commande. S'il se produit en raison d'un paramètre d'entrée incorrect, il peut être modifié en une erreur associée. Dans un autre cas, cette erreur signale une opération invalide ou une configuration système incorrecte, ce qui nécessite un rapport d'enquête plus détaillé. </code></pre></div><blockquote><p><code>E_SIGNATURE</code></p></blockquote> <div class="language- extra-class"><pre><code>Signature incorrecte </code></pre></div><blockquote><p><code>E_STATELOGIN</code></p></blockquote> <div class="language- extra-class"><pre><code>`%s` n'est pas membre de l'écosystème `%s` </code></pre></div><blockquote><p><code>E_TABLENOTFOUND</code></p></blockquote> <div class="language- extra-class"><pre><code>Feuille de données `%s` introuvable </code></pre></div><blockquote><p><code>E_TOKENEXPIRED</code></p></blockquote> <div class="language- extra-class"><pre><code>La session a expiré `%s` </code></pre></div><blockquote><p><code>E_UNAUTHORIZED</code></p></blockquote> <div class="language- extra-class"><pre><code>Non autorisé. En cas de non connexion ou d'expiration de la session, à l'exception de `getuid, login`, toute commande autre que **E_UNAUTHORIZED** renvoie une erreur. </code></pre></div><blockquote><p><code>E_UNKNOWNUID</code></p></blockquote> <div class="language- extra-class"><pre><code>UID inconnu </code></pre></div><blockquote><p><code>E_UPDATING</code></p></blockquote> <div class="language- extra-class"><pre><code>Les nœuds mettent à jour la blockchain </code></pre></div><blockquote><p><code>E_STOPPING</code></p></blockquote> <div class="language- extra-class"><pre><code>Le nœud est arrêté </code></pre></div><blockquote><p><code>E_NOTIMPLEMENTED</code></p></blockquote> <div class="language- extra-class"><pre><code>Pas encore implémenté </code></pre></div><blockquote><p><code>E_BANNED</code></p></blockquote> <div class="language- extra-class"><pre><code>Cette adresse de compte est interdite dans `%s` </code></pre></div><blockquote><p><code>E_CHECKROLE</code></p></blockquote> <div class="language- extra-class"><pre><code>Accès refusé Interface CLB non disponible </code></pre></div><hr> <blockquote><p>Demandes d'interface pour lesquelles le nœud CLB n'est pas disponible.</p></blockquote> <ul><li>metrics</li> <li>txinfo</li> <li>txinfoMultiple</li> <li>appparam</li> <li>appparams</li> <li>appcontent</li> <li>history</li> <li>balance</li> <li>block</li> <li>maxblockid</li> <li>blocks</li> <li>detailed_blocks</li> <li>ecosystemparams</li> <li>systemparams</li> <li>ecosystems</li> <li>ecosystemparam</li> <li>ecosystemname</li> <li>walletHistory</li> <li>tx_record</li></ul> <h2 id="request-type"><a href="#request-type" class="header-anchor">#</a> Type de demande </h2> <p><strong>Utilisation uniforme</strong></p> <ul><li>application/x-www-form-urlencoded</li></ul> <h2 id="authentication-interface"><a href="#authentication-interface" class="header-anchor">#</a> Interface d'authentification </h2> <p><a href="https://jwt.io" target="_blank" rel="noopener noreferrer">JWT token<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a> Utilisé pour l'authentification. Le jeton JWT doit être placé dans l'en-tête de chaque requête après l'avoir reçu : <code>Authorization: Bearer TOKEN_HERE</code>.</p> <h3 id="getuid"><a href="#getuid" class="header-anchor">#</a> getuid </h3> <p><strong>GET</strong>/ retourne une valeur unique, la signe avec la clé privée, puis l'utilise.</p> <p>La commande <a href="#login">login</a> l'envoie de retour au serveur.</p> <p>Génère un jeton JWT temporaire qui doit être transmis à <strong>Authorization</strong> lors de l'appel à <strong>login</strong>.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/getuid </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>uid</code></p> <blockquote><p>Numéro de signature.</p></blockquote></li> <li><p><code>token</code></p> <blockquote><p>Le jeton temporaire passé lors de la connexion.</p> <p>Le cycle de vie d'un jeton temporaire est de 5 secondes.</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>Identifiant du serveur.</p></blockquote></li> <li><p><code>cryptoer</code></p> <blockquote><p>Algorithme de courbe elliptique.</p></blockquote></li> <li><p><code>hasher</code></p> <blockquote><p>Algorithme de hachage.</p></blockquote></li></ul> <p><strong>Exemple de réponse 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>Dans le cas où aucune autorisation n'est requise (la demande contient <strong>Authorization</strong>), le message suivant sera renvoyé :</p> <ul><li><p><code>expire</code></p> <blockquote><p>Temps d'expiration.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>ID de l'écosystème.</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>Adresse du compte.</p></blockquote></li> <li><p><code>address</code></p> <blockquote><p>Adresse du portefeuille <code>XXXX-XXXX-..... -XXXX</code>.</p></blockquote></li> <li><p><code>network_id</code></p> <blockquote><p>Identifiant du serveur.</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>Réponse d'erreur</strong></p> <p><em>E_SERVER</em></p> <h3 id="login"><a href="#login" class="header-anchor">#</a> login </h3> <p><strong>POST</strong>/ Authentification de l'utilisateur.</p> <blockquote><p><strong>getuid</strong> doit être appelé en premier pour recevoir la valeur unique et la signer. Le jeton JWT temporaire de getuid doit être transmis dans l'en-tête de la requête.</p> <p>Si la requête réussit, le jeton reçu dans la réponse est contenu dans <strong>Authorization</strong>.</p></blockquote> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/login </code></pre></div><ul><li><p><code>ecosystem</code> (écosystème)</p> <blockquote><p>Identifiant de l'écosystème.</p> <p>Si non spécifié, il est par défaut défini sur le premier identifiant d'écosystème.</p></blockquote></li> <li><p><code>expire</code> (expiration)</p> <blockquote><p>Durée de vie du jeton JWT, en secondes, par défaut 28800.</p></blockquote></li> <li><p><code>pubkey</code> (clé publique)</p> <blockquote><p>Clé publique du compte en format hexadécimal.</p></blockquote></li> <li><p><code>key_id</code> (identifiant de clé)</p> <blockquote><p>Adresse du compte au format <code>XXXX-...-XXXX</code>.</p> <p>Utilisez ce paramètre si la clé publique est déjà stockée dans la blockchain. Il ne peut pas être utilisé avec les paramètres <em>pubkey</em> en même temps.</p></blockquote></li> <li><p><code>signature</code> (signature)</p> <blockquote><p>La signature uid reçue via getuid.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>token</code></p> <blockquote><p>Jeton JWT.</p></blockquote></li> <li><p><code>ecosystem_id</code></p> <blockquote><p>ID de l'écosystème.</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>ID de l'adresse du compte.</p></blockquote></li> <li><p><code>account</code></p> <blockquote><p>Adresse du portefeuille <code>XXXX-XXXX-..... -XXXX</code>.</p></blockquote></li> <li><p><code>notify_key</code></p> <blockquote><p>ID de notification.</p></blockquote></li> <li><p><code>isnode</code></p> <blockquote><p>Indique si l'adresse du compte est le propriétaire du nœud. Valeurs : <code>true,false</code>.</p></blockquote></li> <li><p><code>isowner</code></p> <blockquote><p>Indique si l'adresse du compte est le créateur de l'écosystème. Valeurs : <code>true,false</code>.</p></blockquote></li> <li><p><code>clb</code></p> <blockquote><p>Indique si l'écosystème connecté est CLB. Valeurs : <code>true,false</code>.</p></blockquote></li> <li><p><code>roles</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Liste des rôles : <code>[{ID du rôle, Nom du rôle}]</code>.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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> Interface de commande côté serveur </h2> <h3 id="version"><a href="#version" class="header-anchor">#</a> version </h3> <p><strong>GET</strong>/ Retourne la version actuelle du serveur.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/version </code></pre></div><p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json "1.3.0 branch.main commit.790..757 time.2021-08-23-08:20:19(UTC)" </code></pre></div><h2 id="data-request-function-interface"><a href="#data-request-function-interface" class="header-anchor">#</a> Data Request Function Interface </h2> <h3 id="balance"><a href="#balance" class="header-anchor">#</a> balance </h3> <p><strong>GET</strong>/ Demande le solde de l'adresse du compte dans l'écosystème actuel.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/balance/{wallet} </code></pre></div><ul><li><p><code>portefeuille</code></p> <blockquote><p>Identifiant d'adresse, peut être spécifié dans n'importe quel format <code>int64, uint64, XXXX-... -XXXX</code>. Recherchez l'adresse dans l'écosystème où l'utilisateur est actuellement connecté.</p></blockquote></li> <li><p><code>écosystème</code> <a href="#omitempty">Omitempty</a> Écosystème par défaut 1</p> <blockquote><p>Identifiant de l'écosystème.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>montant</code></p> <blockquote><p>L'unité minimale du solde du compte de contrat.</p></blockquote></li> <li><p><code>argent</code></p> <blockquote><p>Solde du compte.</p></blockquote></li> <li><p><code>total</code></p> <blockquote><p>Solde du compte.</p></blockquote></li> <li><p><code>utxo</code></p> <blockquote><p>Solde du compte UTXO.</p></blockquote></li> <li><p><em>chiffres</em></p> <blockquote><p>précision.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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", "digits": 6, "utxo": "0" } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_SERVER, E_INVALIDWALLET</em></p> <h3 id="blocks"><a href="#blocks" class="header-anchor">#</a> blocks </h3> <p><strong>GET</strong>/ Retourne une liste contenant des informations supplémentaires liées aux transactions dans chaque bloc.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</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> La valeur par défaut est 0</p> <blockquote><p>La hauteur du bloc de départ à interroger.</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (par défaut 25, requête maximale 1000)</p> <blockquote><p>Nombre de blocs.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>Hauteur de bloc</code></p> <blockquote><p>Liste des transactions dans le bloc et des informations supplémentaires pour chaque transaction.</p> <blockquote><ul><li><code>hash</code></li></ul> <blockquote><p>Hash de la transaction.</p></blockquote> <ul><li><code>contract_name</code></li></ul> <blockquote><p>Nom du contrat.</p></blockquote> <ul><li><code>params</code></li></ul> <blockquote><p>Tableau des paramètres du contrat.</p></blockquote> <ul><li><code>key_id</code></li></ul> <blockquote><p>Pour le premier bloc, il s'agit de l'adresse du compte du premier bloc qui a signé la transaction.</p></blockquote> <blockquote><p>Pour tous les autres blocs, c'est l'adresse du compte qui a signé la transaction.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_SERVER, E_NOTFOUND</em></p> <h3 id="detailed-blocks"><a href="#detailed-blocks" class="header-anchor">#</a> detailed_blocks </h3> <p><strong>GET</strong>/ Retourne une liste contenant des informations détaillées supplémentaires sur les transactions de chaque bloc.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</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> La valeur par défaut est 0</p> <blockquote><p>La hauteur du bloc de départ à interroger.</p></blockquote></li> <li><p><code>count</code> <a href="#omitempty">Omitempty</a> (par défaut 25, requête maximale 1000)</p> <blockquote><p>Nombre de blocs.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><code>Block height</code> La hauteur du bloc. <ul><li><code>blockhead</code> L'en-tête du bloc contient les champs suivants. <ul><li><code>block_id</code> Hauteur du bloc.</li> <li><code>time</code> Horodatage de génération du bloc.</li> <li><code>key_id</code> Adresse du compte qui a signé le bloc.</li> <li><code>node_position</code> L'emplacement du nœud qui a généré le bloc dans la liste des nœuds d'honneur.</li> <li><code>version</code> Version de la structure du bloc.</li></ul></li> <li><code>hash</code> Hash du bloc.</li> <li><code>node_position</code> L'emplacement du nœud qui a généré le bloc dans la liste des nœuds d'honneur.</li> <li><code>key_id</code> L'adresse du compte qui a signé le bloc.</li> <li><code>time</code> Horodatage de génération du bloc.</li> <li><code>tx_count</code> Nombre de transactions dans le bloc.</li> <li><code>size</code> La taille du bloc.</li> <li><code>rollback_hash</code> Hash de rollback du bloc.</li> <li><code>merkle_root</code> Le bloc traite l'arbre de Merkle.</li> <li><code>bin_data</code> Sérialisation de l'en-tête du bloc, de toutes les transactions du bloc, du hash du bloc précédent et de la clé privée du nœud qui a généré le bloc.</li> <li><code>transactions</code> Liste des transactions dans le bloc et des informations supplémentaires sur chaque transaction. <ul><li><code>hash</code> Hash de la transaction.</li> <li><code>contract_name</code> Nom du contrat.</li> <li><code>params</code> Paramètres du contrat.</li> <li><code>key_id</code> Adresse du compte qui a signé cette transaction.</li> <li><code>time</code> Horodatage de génération de la transaction.</li> <li><code>type</code> Type de transaction.</li> <li><code>size</code> Taille de la transaction.</li></ul></li></ul></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>/ Si le hachage spécifié correspond aux données de la montre binaire, du champ et des enregistrements, cette demande renverra les données. Sinon, une erreur sera renvoyée.</p> <p>La demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</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>Identifiant d'enregistrement.</p></blockquote></li> <li><p><code>hash</code></p> <blockquote><p>Hacher les données de la requête.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <blockquote><p>Données binaires</p></blockquote> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_SERVER, E_NOTFOUND, E_HASHWRONG</em></p> <h3 id="data-table-id-column-hash"><a href="#data-table-id-column-hash" class="header-anchor">#</a> /data/{table}/id/{column}/{hash} </h3> <p><strong>GET</strong>/ Si le hachage spécifié correspond aux données dans la table, le champ et les enregistrements spécifiés, la requête renverra les données. Sinon, une erreur sera renvoyée.</p> <p>La requête ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /data/{table}/id/{column}/{hash} </code></pre></div><ul><li><p><code>table</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>id</code></p> <blockquote><p>Identifiant d'enregistrement.</p></blockquote></li> <li><p><code>column</code></p> <blockquote><p>Nom de la table de données, un seul</p></blockquote></li> <li><p><code>hash</code></p> <blockquote><p>Données de demande de hachage.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <blockquote><p>Données binaires</p></blockquote> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/octet-stream 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>Réponse d'erreur</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>/ Retournez à une liste d'écosystèmes, qui contient le rôle d'enregistrement de l'adresse spécifiée.</p> <p>La demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</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>Identifiant de l'adresse, vous pouvez spécifier <code>int64, uint64, xxxx -...-xxxx</code>.</p> <p>Cette requête est une recherche dans tous les écosystèmes.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>Identifiant de l'écosystème.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Nom de l'écosystème.</p></blockquote></li> <li><p><code>roles</code></p> <blockquote><p>Activités avec les champs <em>id</em> et <em>nom</em>.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>/ Retournez à l'historique des transactions du compte courant, recherchez-le en fonction de l'identifiant de l'ID.</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Demande</strong></p> <ul><li><p><code>searchType</code></p> <blockquote><p>Trouver le type (Revenu : Convertir en Résultat : Tout, par défaut).</p></blockquote></li> <li><p><code>page</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Trouver le nombre de pages, la première page par défaut, min : 1</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Nombre de crédits, 20 articles par défaut. 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>Réponse</strong></p> <ul><li><p><code>total</code></p> <blockquote><p>Nombre total d'entrées.</p></blockquote></li> <li><p><code>page</code></p> <blockquote><p>Numéro de la page actuelle.</p></blockquote></li> <li><p><code>limit</code></p> <blockquote><p>Actuellement, trouvez le nombre de bars.</p></blockquote></li> <li><p><code>list</code> Chaque élément dans le tableau contient les paramètres suivants :</p> <ul><li><code>id</code> ID Stripe.</li> <li><code>sender_id</code> ID de l'expéditeur.</li> <li><code>sender_add</code> Adresse du compte de l'expéditeur.</li> <li><code>recipient_id</code> ID du destinataire.</li> <li><code>recipient_add</code> Adresse du compte du destinataire.</li> <li><code>amount</code> Montant de la transaction.</li> <li><code>comment</code> Remarques sur la transaction.</li> <li><code>block_id</code> Hauteur du bloc.</li> <li><code>tx_hash</code> Hash de la transaction.</li> <li><code>created_at</code> Heure de création de la transaction, en millisecondes.</li> <li><code>money</code> Montant de la transaction.</li></ul></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>/ Retournez à l'entrée du tableau de données spécifié dans l'écosystème actuel. Vous pouvez spécifier les colonnes à retourner.</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Numéro de crédit, par défaut 25.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Disposition, par défaut 0.</p></blockquote></li> <li><p><code>order</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Méthode de tri, par défaut <code>id ASC</code>.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>La liste des colonnes demandées est séparée par des virgules. Si elle n'est pas spécifiée, toutes les colonnes seront renvoyées. Dans tous les cas, la colonne <code>id</code> sera renvoyée.</p></blockquote></li> <li><p><code>where</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Condition de requête</p> <p>Exemple : Si vous souhaitez interroger id> 2 et name = john</p> <p>Vous pouvez utiliser : where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}</p> <p>Pour plus de détails, veuillez vous référer à la syntaxe [DBFind](../ topics/script.md#dbfind) where.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/listWhere/mytable </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Nombre total d'entrées.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément dans le tableau contient les paramètres suivants :</p></blockquote> <ul><li><code>id</code> <blockquote><p>ID Stripe.</p></blockquote></li> <li><code>...</code> <blockquote><p>Autres colonnes des tables de données.</p></blockquote></li></ul></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>/ Retournez à la table de données spécifiée. Vous pouvez spécifier les colonnes à retourner. Effectue un encodage hexadécimal des types de données <strong>BYTEA</strong> dans la table.</p> <p><a href="#authorization">Authorization</a></p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Numéro de crédit, par défaut 25.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Disposition, par défaut à 0.</p></blockquote></li> <li><p><code>order</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Méthode de tri, par défaut <code>id ASC</code>.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>La liste des colonnes demandées est séparée par des virgules. Si elle n'est pas spécifiée, toutes les colonnes seront renvoyées. Dans tous les cas, la colonne <code>id</code> sera renvoyée.</p></blockquote></li> <li><p><code>where</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Condition de requête</p> <p>Exemple : Si vous souhaitez interroger id> 2 et name = john</p> <p>Vous pouvez utiliser : where: {"id": {"$ gt": 2}, "name": {"$eq": "john"}}</p> <p>Pour plus de détails, veuillez vous référer à la syntaxe [DBFind](../ topics/script.md#dbfind) where.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/nodelistWhere/mytable </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Nombre total d'entrées.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément dans le tableau contient les paramètres suivants :</p></blockquote> <ul><li><code>id</code> <blockquote><p>ID Stripe.</p></blockquote></li> <li><code>...</code> <blockquote><p>Autres colonnes des tables de données.</p></blockquote></li></ul></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_SERVER</em>,<em>E_TABLENOTFOUND</em></p> <h2 id="get-metrics-interface"><a href="#get-metrics-interface" class="header-anchor">#</a> Obtenir l'interface des métriques </h2> <h3 id="metrics-keys"><a href="#metrics-keys" class="header-anchor">#</a> metrics/keys </h3> <p><strong>GET</strong>/ Retourne le nombre d'adresses de compte de l'écosystème 1.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/keys </code></pre></div><p><strong>Exemple de réponse</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>/ Retourne le nombre de blocs.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/blocks </code></pre></div><p><strong>Exemple de réponse</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>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/transactions </code></pre></div><p><strong>Exemple de réponse</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>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/metrics/ecosystems </code></pre></div><p><strong>Exemple de réponse</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>/ Retourne le nombre de nœuds d'honneur.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <div class="language- extra-class"><pre class="language-text"><code>GET /api/v2/metrics/honornodes </code></pre></div><p><strong>Exemple de réponse</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> Interface de l'écosystème </h2> <h3 id="ecosystemname"><a href="#ecosystemname" class="header-anchor">#</a> ecosystemname </h3> <p><strong>GET</strong>/ Retourne le nom de l'écosystème par son identifiant.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</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>Identifiant de l'écosystème.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>/ Renvoie une liste de paramètres d'application dans l'écosystème actuel ou spécifié.</p> <p><strong>Demande</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>Identifiant de l'application.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>Identifiant de l'écosystème ; si non spécifié, le paramètre d'écosystème actuel sera renvoyé.</p></blockquote></li> <li><p><code>names</code></p> <blockquote><p>La liste des paramètres reçus.</p> <p>Vous pouvez spécifier une liste de noms de paramètres séparés par des virgules, par exemple : <code>/api/v2/appparams/1?names=name,mypar</code>.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <ul><li><code>nom</code>, le nom du paramètre.</li> <li><code>valeur</code>, la valeur du paramètre.</li> <li><code>conditions</code>, modifier les permissions des paramètres.</li></ul></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="appparam-appid-name"><a href="#appparam-appid-name" class="header-anchor">#</a> appparam/{appid}/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie des informations sur le paramètre <strong>{name}</strong> de l'application <strong>{appid}</strong> dans l'écosystème actuel ou spécifié.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/appparam/{appid}/{name}[?ecosystem=1] </code></pre></div><ul><li><p><code>appid</code></p> <blockquote><p>Identifiant de l'application.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Le nom du paramètre demandé.</p></blockquote></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Identifiant de l'écosystème (paramètre facultatif).</p> <p>Renvoie l'écosystème actuel par défaut.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>Identifiant du paramètre.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Nom du paramètre.</p></blockquote></li> <li><p><code>value</code></p> <blockquote><p>La valeur du paramètre.</p></blockquote></li> <li><p><code>conditions</code></p> <blockquote><p>Autorisation de modifier les paramètres.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "id": "10", "name": "par", "value": "My value", "conditions": "true" } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_ECOSYSTEM, E_PARAMNOTFOUND</em></p> <h3 id="ecosystemparams"><a href="#ecosystemparams" class="header-anchor">#</a> ecosystemparams </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie une liste de paramètres de l'écosystème.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/ecosystemparams/[?ecosystem=... &names=...] </code></pre></div><ul><li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Identifiant de l'écosystème. if not specified, the current ecosystem ID will be returned.</p></blockquote></li> <li><p><code>names</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Liste des paramètres de demande, séparés par des virgules.</p> <p>Par exemple: <code>/api/v2/ecosystemparams/?names=name,currency,logo</code>.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <ul><li><code>name</code></li></ul> <blockquote><p>Nom du paramètre.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Valeur du paramètre.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Modifier les autorisations pour les paramètres.</p></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [{ "name": "name", "value": "MyState", "conditions": "true", }, { "name": "currency", "value": "MY", "conditions": "true", }, ] } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="ecosystemparam-name"><a href="#ecosystemparam-name" class="header-anchor">#</a> ecosystemparam/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie des informations sur le paramètre <strong>{name}</strong> dans l'écosystème actuel ou spécifié.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/ecosystemparam/{name}[?ecosystem=1] </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>Le nom du paramètre demandé.</p></blockquote></li> <li><p><code>ecosystem</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>La valeur par défaut est de renvoyer l'ID de l'écosystème actuel.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom du paramètre.</p></blockquote></li> <li><p><code>value</code></p> <blockquote><p>La valeur du paramètre.</p></blockquote></li> <li><p><code>conditions</code></p> <blockquote><p>Autorisation de modifier les paramètres.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "name": "currency", "value": "MYCUR", "conditions": "true" } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_ECOSYSTEM</em></p> <h3 id="tables-limit-offset"><a href="#tables-limit-offset" class="header-anchor">#</a> tables/[?limit=... &offset=... ] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Retourne une liste de tables de données pour l'écosystème actuel. Vous pouvez définir le décalage et le nombre d'entrées.</p> <p><strong>Demande</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Nombre d'entrées, par défaut 100, maximum 1000.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Décalage, la valeur par défaut est 0.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/tables?limit=... &offset=... </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Le nombre total d'entrées dans le tableau de données.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Nom de la table de données sans préfixe.</p></blockquote> <ul><li><code>count</code></li></ul> <blockquote><p>Le nombre d'entrées dans la table de données.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "100" "list": [{ "name": "accounts", "count": "10", }, { "name": "citizens", "count": "5", }, ] } </code></pre></div><h3 id="table-name"><a href="#table-name" class="header-anchor">#</a> table/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie des informations sur la table de données de la demande actuelle de l'écosystème.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</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>Renvoie les informations de champ suivantes.</p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>insert</code></p> <blockquote><p>Permission d'ajouter de nouvelles entrées.</p></blockquote></li> <li><p><code>new_column</code></p> <blockquote><p>Ajouter des permissions de champ.</p></blockquote></li> <li><p><code>update</code></p> <blockquote><p>Modifier les permissions d'entrée.</p></blockquote></li> <li><p><code>columns</code></p> <blockquote><p>Tableau d'informations liées au champ.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Nom du champ.</p></blockquote> <ul><li><code>type</code></li></ul> <blockquote><p>Type de données du champ.</p></blockquote> <ul><li><code>perm</code></li></ul> <blockquote><p>Modifier les permissions pour la valeur du champ.</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>/ Renvoie une liste des entrées de table de données spécifiées dans l'écosystème actuel. Vous pouvez définir le décalage et le nombre d'entrées.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Nombre d'entrées, par défaut 25 entrées.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Décalage, par défaut est 0.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Une liste de colonnes demandées, séparées par des virgules. Si non spécifié, toutes les colonnes seront renvoyées. La colonne id sera renvoyée dans tous les cas.</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>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Nombre total d'entrées.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>ID de l'entrée.</p></blockquote> <ul><li>La séquence des colonnes de requête.</li></ul></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</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>/ Retourne une liste d'entrées dans la table <em>sections</em> de l'écosystème actuel, avec la possibilité de définir un décalage et un nombre d'entrées.</p> <p>Si le champ <em>role_access</em> contient une liste de rôles et n'inclut pas le rôle actuel, aucun enregistrement ne sera renvoyé. Les données dans le champ <em>title</em> seront remplacées par la ressource linguistique spécifiée dans l'en-tête de la requête <em>Accept-Language</em>.</p> <p><strong>Demande</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Nombre d'entrées, par défaut 25 entrées.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Décalage, par défaut est 0.</p></blockquote></li> <li><p><code>lang</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Ce champ spécifie le code de ressource multilingue ou la localisation, par exemple, <em>en, de</em>. Si la ressource linguistique spécifiée n'est pas trouvée, par exemple, <em>en-US</em>, elle recherchera dans le groupe de ressources linguistiques <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>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p><em>sections</em> Nombre total d'entrées de table.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient des informations sur toutes les colonnes de la table des actions.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "2" "list": [{ "id": "1", "title": "Development", "urlpage": "develop", ... }, ] } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_TABLENOTFOUND</em></p> <h3 id="row-name-id-columns"><a href="#row-name-id-columns" class="header-anchor">#</a> row/{name}/{id}[?columns=] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Retourne l'entrée pour la table de données spécifiée dans l'écosystème actuel. Vous pouvez spécifier les colonnes à retourner.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>id</code></p> <blockquote><p>Identifiant d'entrée.</p></blockquote></li> <li><p><code>columns</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Une liste de colonnes demandées, séparées par des virgules. Si aucune colonne n'est spécifiée, toutes les colonnes seront renvoyées. La colonne "id" sera renvoyée dans tous les cas.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/row/mytable/10?columns=name </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>value</code></p> <blockquote><p>Tableau des valeurs de colonne reçues</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>Identifiant d'entrée.</p></blockquote> <ul><li>La séquence des colonnes de demande.</li></ul></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "values": { "id": "10", "name": "John", } } </code></pre></div><p><strong>Réponse d'erreur</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>/ Retournez à l'entrée du tableau de données spécifié dans l'écosystème actuel. Vous pouvez spécifier les colonnes à retourner.</p> <p><strong>Demande</strong></p> <ul><li><p><code>Name</code></p> <blockquote><p>Nom de la table de données.</p></blockquote></li> <li><p><code>colorn</code></p> <blockquote><p>Liste des données de nom.</p></blockquote></li> <li><p><code>ID</code></p> <blockquote><p>Identifiant Stripe.</p></blockquote></li> <li><p><code>columns</code> [omitempty] (#omitempty)</p> <blockquote><p>La liste des listes de demandes est séparée par des virgules. Si cela n'est pas spécifié, toutes les colonnes seront renvoyées. Dans tous les cas, la colonne ID sera renvoyée.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/row/mytable/name/John?columns=name </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>value</code></p> <blockquote><p>Tableau des valeurs de colonnes de réception Prévision</p> <ul><li><code>ID</code></li></ul> <blockquote><blockquote><p>Supprimer l'ID.</p></blockquote></blockquote> <ul><li>-La séquence de la colonne de demande.</li></ul></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "values": { "id": "10", "name": "John", } } </code></pre></div><p><strong>Réponse d'erreur</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>/ Renvoie une liste de paramètres de plateforme.</p> <p><strong>Demande</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>Une liste de paramètres de requête, séparés par des virgules. Par exemple: <code>/api/v2/systemparams/?names=max_columns,max_indexes</code>.</p></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Nom du paramètre.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Valeurs des paramètres.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Changer la permission du paramètre.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [{ "name": "max_columns", "value": "100", "conditions": "ContractAccess("@1UpdateSysParam")", }, { "name": "max_indexes", "value": "1", "conditions": "ContractAccess("@1UpdateSysParam")", }, ] } </code></pre></div><p><strong>Réponse d'erreur</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>/ Retourne l'enregistrement des modifications pour l'entrée dans la table de données spécifiée dans l'écosystème actuel.</p> <p><strong>Demande</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>Nom de la table de données.</p> <ul><li><code>id</code></li></ul> <blockquote><p>Identifiant d'entrée.</p></blockquote></blockquote> <p><strong>Réponse</strong></p> <blockquote><ul><li><code>list</code></li></ul> <p>Chaque élément du tableau contient un enregistrement de modification pour l'entrée demandée.</p></blockquote> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "list": [ { "name": "default_page", "value": "P(class, Default Ecosystem Page)" }, { "menu": "default_menu" } ] } </code></pre></div><h3 id="interface-page-menu-snippet-name"><a href="#interface-page-menu-snippet-name" class="header-anchor">#</a> interface/{page|menu|snippet}/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie les entrées du champ <em>name</em> dans la table de données spécifiée du système écologique (pages, menu ou snippet).</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>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Spécifiez le nom de l'entrée dans la table.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>Identifiant d'entrée.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Nom de l'entrée.</p></blockquote></li> <li><p><code>other</code></p> <blockquote><p>Autres colonnes du tableau.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "id": "1", "name": "default_page", "value": "P(Page content)", "default_menu": "default_menu", "validate_count": 1 } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_QUERY</em>, <em>E_NOTFOUND</em></p> <h2 id="contract-function-interface"><a href="#contract-function-interface" class="header-anchor">#</a> Contract Function Interface </h2> <h3 id="contracts-limit-offset"><a href="#contracts-limit-offset" class="header-anchor">#</a> contracts[?limit=... &offset=... ] </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Retourne une liste de contrats dans l'écosystème actuel, avec la possibilité de définir des décalages et le nombre d'entrées.</p> <p><strong>Demande</strong></p> <ul><li><p><code>limit</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Nombre d'entrées, par défaut 25 entrées.</p></blockquote></li> <li><p><code>offset</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Décalage, la valeur par défaut est 0.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/contracts </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>count</code></p> <blockquote><p>Nombre total d'entrées.</p></blockquote></li> <li><p><code>list</code></p> <blockquote><p>Chaque élément du tableau contient les paramètres suivants.</p> <blockquote><ul><li><code>id</code></li></ul> <blockquote><p>ID du contrat.</p></blockquote> <ul><li><code>name</code></li></ul> <blockquote><p>Nom du contrat.</p></blockquote> <ul><li><code>value</code></li></ul> <blockquote><p>Contenu du contrat.</p></blockquote> <ul><li><code>wallet_id</code></li></ul> <blockquote><p>Adresse du compte auquel le contrat est lié.</p></blockquote> <ul><li><code>address</code></li></ul> <blockquote><p>Adresse du portefeuille lié au contrat <code>XXXX-... -XXXX</code>.</p></blockquote> <ul><li><code>ecosystem_id</code></li></ul> <blockquote><p>ID de l'écosystème auquel le contrat appartient.</p></blockquote> <ul><li><code>app_id</code></li></ul> <blockquote><p>ID de l'application auquel le contrat appartient.</p></blockquote> <ul><li><code>conditions</code></li></ul> <blockquote><p>Modifier la permission du contrat.</p></blockquote> <ul><li><code>token_id</code></li></ul> <blockquote><p>ID de l'écosystème où le pass est utilisé pour payer les frais du contrat.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "count": "10" "list": [{ "id": "1", "name": "MainCondition", "token_id": "1", "wallet_id": "0", "value": "contract MainCondition { conditions { if(EcosysParam(`founder_account`)!=$key_id) { warning `Sorry, you dont have access to this action.` } } }", "address":"0000-0000-0000-0000-0000", "conditions":"ContractConditions(`MainCondition`)" }, ... ] } </code></pre></div><h3 id="contract-name"><a href="#contract-name" class="header-anchor">#</a> contract/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>GET</strong>/ Renvoie des informations sur le contrat spécifié. Par défaut, la requête concerne le contrat dans l'écosystème actuel.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom du contrat intelligent.</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>Réponse</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>ID du contrat dans la machine virtuelle.</p></blockquote></li> <li><p><code>name</code></p> <blockquote><p>Nom du contrat avec l'ID de l'écosystème <code>@1MainCondition</code>.</p></blockquote></li> <li><p><code>state</code></p> <blockquote><p>L'ID de l'écosystème du contrat.</p></blockquote></li> <li><p><code>walletid</code></p> <blockquote><p>L'adresse du compte auquel le contrat est lié.</p></blockquote></li> <li><p><code>tokenid</code></p> <blockquote><p>L'ID de l'écosystème du pass utilisé pour payer le contrat.</p></blockquote></li> <li><p><code>address</code></p> <blockquote><p>Adresse du portefeuille lié au contrat <code>XXXX-... -XXXX</code>.</p></blockquote></li> <li><p><code>tableid</code></p> <blockquote><p>ID de l'entrée dans la table <em>contracts</em> où se trouve le contrat.</p></blockquote></li> <li><p><code>fields</code></p> <blockquote><p>Le tableau contient des informations structurelles pour chaque paramètre de la section <strong>data</strong> du contrat.</p> <blockquote><ul><li><code>name</code></li></ul> <blockquote><p>Nom du paramètre.</p></blockquote> <ul><li><code>type</code></li></ul> <blockquote><p>Type de paramètre.</p></blockquote> <ul><li><code>optional</code></li></ul> <blockquote><p>Options du paramètre, `true` signifie que le paramètre est facultatif, `false` signifie que le paramètre est obligatoire.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "fields" : [ {"name": "amount", "type": "int", "optional": false}, {"name": "name", "type": "string", "optional": true} ], "id": 150, "name":"@1mycontract", "tableid" : 10, } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_CONTRACT</em></p> <h3 id="sendtx"><a href="#sendtx" class="header-anchor">#</a> sendTX </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong>/ Reçoit les transactions dans les paramètres et les ajoute à la file d'attente des transactions, renvoyant un hachage de transaction si la requête est exécutée avec succès. Ce hachage permet d'obtenir la transaction correspondante dans le bloc et est inclus dans le message d'erreur en cas de réponse d'erreur.</p> <p><strong>Demande</strong></p> <ul><li><p><code>tx_key</code></p> <blockquote><p>Contenu de la transaction, ce paramètre peut spécifier n'importe quel nom et prend en charge la réception de plusieurs transactions.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/sendTx Headers: Content-Type: multipart/form-data Parameters: tx1 - Transaction 1 txN - Trading N </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>hashes</code></p> <blockquote><p>Tableau de hachages de transactions.</p> <blockquote><ul><li><code>tx1</code></li></ul> <blockquote><p>Hachage de la transaction 1.</p></blockquote> <ul><li><code>txN</code></li></ul> <blockquote><p>Hachage de la transaction N.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "hashes": { "tx1": "67afbc435634..... ", "txN": "89ce4498eaf7..... ", } </code></pre></div><p><strong>Réponse d'erreur</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>/ Retourne l'ID du bloc et le message d'erreur pour le hachage de transaction spécifié. Si les valeurs de retour pour l'ID du bloc et le message d'erreur sont nulles, alors la transaction n'est pas encore contenue dans le bloc.</p> <p><strong>Demande</strong></p> <ul><li><p><code>data</code></p> <blockquote><p>Liste JSON des hachages de transaction.</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>Réponse</strong></p> <ul><li><p><code>results</code></p> <blockquote><p>La clé de la transaction est le hash et les détails de la transaction sont la valeur dans le dictionnaire de données.</p> <p><code>hash</code></p> <blockquote><p>Hash de la transaction.</p> <ul><li><p><code>blockid</code></p> <blockquote><p>Si la transaction est exécutée avec succès, l'ID du bloc sera renvoyé. Si la transaction échoue, le <em>blockid</em> sera [0]{.title-ref}.</p></blockquote></li> <li><p><code>result</code></p> <blockquote><p>Renvoie le résultat de la transaction via la variable <strong>$result</strong>.</p></blockquote></li> <li><p><code>errmsg</code></p> <blockquote><p>Renvoie un message d'erreur si l'exécution de la transaction échoue.</p></blockquote></li></ul></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "results": { "hash1": { "blockid": "3123", "result": "", }, "hash2": { "blockid": "3124", "result": "", } } } </code></pre></div><p><strong>Réponse d'erreur</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>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>GET</strong>/</p> <p>Renvoie des informations sur la transaction pour le hachage spécifié, y compris l'ID du bloc et le nombre de confirmations. Renvoie également le nom du contrat et ses paramètres associés, si des paramètres optionnels sont spécifiés.</p> <p><strong>Demande</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>Hash de transaction.</p></blockquote></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Identifiant du paramètre de détails du contrat, pour obtenir les détails du contrat liés à cette transaction, veuillez spécifier <code>contractinfo=1</code>.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/txinfo/c7ef367b494c7ce855f09aa3f1f2af7402535ea627fa615ebd63d437db5d0c8a?contractinfo=1 </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>blockid</code></p> <blockquote><p>Si la valeur est <code>0</code>, alors aucune transaction n'a été trouvée pour ce hachage.</p></blockquote></li> <li><p><code>confirm</code></p> <blockquote><p>Le nombre de confirmations pour ce bloc <em>blockid</em>.</p></blockquote></li> <li><p><code>data</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Si <code>contentinfo=1</code> est spécifié, les détails du contrat sont renvoyés à ce paramètre.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "blockid": "9", "confirm": 11, "data": { "block": "9", "contract": "@1NewContract", "params": { "ApplicationId": 1, "Conditions": "true", "Value": "contract crashci4b {\n\t\t\tdata {}\n\t\t\t}" } } } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_HASHWRONG</em></p> <h3 id="txinfomultiple"><a href="#txinfomultiple" class="header-anchor">#</a> txinfoMultiple </h3> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>GET</strong>/</p> <p>Retourne les informations liées à la transaction pour le hachage spécifié.</p> <p><strong>Demande</strong></p> <ul><li><p><code>data</code></p> <ul><li><code>hashes</code></li></ul> <blockquote><p>Une liste de hachages de transactions.</p></blockquote></li> <li><p><code>contractinfo</code> <a href="#omitempty">Omitempty</a></p> <blockquote><p>Identifiant du paramètre de détails du contrat, pour obtenir les détails du contrat liés à cette transaction, veuillez spécifier <code>contractinfo=1</code>.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>data: {"hashes":["contract1hash", "contract2hash", "contract3hash"]} </code></pre></div><div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/txinfoMultiple </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>results</code></p> <blockquote><p>La clé utilisée est le hachage de la transaction et le détail de la transaction est utilisé comme valeur dans le dictionnaire de données.</p> <blockquote><p><code>hash</code></p> <blockquote><p>Trading Hash. (Trading de hachage)</p></blockquote> <blockquote><p><code>blockid</code></p></blockquote></blockquote> <p>Si la valeur est <code>0</code>, alors aucune transaction n'a été trouvée pour ce hachage.</p> <blockquote><blockquote><p><code>confirm</code></p></blockquote> <blockquote><p>Nombre de reconnaissances pour ce bloc <em>blockid</em>.</p></blockquote> <blockquote><p><code>data</code></p></blockquote> <blockquote><p>Si <code>contentinfo=1</code> est spécifié, les détails du contrat sont renvoyés à ce paramètre.</p></blockquote></blockquote></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "results": { "hash1": { "blockid": "3123", "confirm": "5", }, "hash2": { "blockid": "3124", "confirm": "3", } } } </code></pre></div><p><strong>Réponse d'erreur</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>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>GET</strong></p> <p>Retourne le nombre de nœuds à valider pour la page spécifiée.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la page avec l'ID de l'écosystème au format <code>@ecosystem_id%%nom_de_la_page%</code>, par exemple :</p> <p><code>@1page_principale</code>.</p> <p>Si vous n'avez pas d'ID d'écosystème, recherchez par défaut dans la première page de l'écosystème.</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>Réponse</strong></p> <ul><li><p><code>validate_count</code></p> <blockquote><p>Spécifie le nombre de nœuds à valider pour la page.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="content-menu-page-name"><a href="#content-menu-page-name" class="header-anchor">#</a> content/menu|page/{name} </h3> <p><a href="#authorization">Authorization</a></p> <p><strong>POST</strong></p> <p>Retourne un arbre d'objets JSON de code pour la page ou le nom du menu spécifié, qui est le résultat du traitement par le moteur de template.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la page ou du menu avec l'ID de l'écosystème au format <code>@ecosystem_id%%nom_de_la_page%</code>, par exemple :</p> <p><code>@1page_principale</code>.</p> <p>Si aucun ID d'écosystème n'est inclus, recherchez par défaut la page ou le menu de l'écosystème actuel.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content/page/default </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>menu</code> || <code>title</code></p> <blockquote><p>demande <em>content/page/...</em> Le nom du menu auquel la page appartient lors de la demande.</p></blockquote></li> <li><p><code>menutree</code></p> <blockquote><p>demande <em>content/page/...</em> L'arborescence JSON de l'objet menu de la page lorsqu'elle est demandée.</p></blockquote></li> <li><p><code>title</code> --head pour le menu <em>content/menu/...</em></p> <blockquote><p>demande <em>content/menu/...</em> Titre du menu lorsqu'il est demandé.</p></blockquote></li> <li><p><code>tree</code></p> <blockquote><p>Arborescence JSON de la page ou du menu.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>Retourne un arbre d'objets JSON codés pour le nom de page spécifié. N'exécute aucune fonction ni ne reçoit de données. L'arbre d'objets JSON retourné correspond au modèle de page et peut être utilisé dans le concepteur de page visuel. Si la page n'est pas trouvée, une erreur 404 est renvoyée.</p> <p><strong>Demande</strong></p> <ul><li><p><code>name</code></p> <blockquote><p>Nom de la page avec l'ID de l'écosystème au format <code>@ecosystem_id%%nom_de_la_page%</code>, par exemple :</p> <p><code>@1page_principale</code>.</p> <p>Si aucun ID d'écosystème n'est inclus, recherchez par défaut la page éco actuelle.</p></blockquote></li></ul> <p><strong>Réponse</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>Arbre d'objet JSON de la page.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</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>Retourne un hachage SHA256 du nom de page spécifié, ou une erreur 404 si la page ne peut pas être trouvée.</p> <p>Cette requête ne nécessite pas d'autorisation de connexion. Pour recevoir le hachage correct lors de l'envoi de demandes à d'autres nœuds, vous devez également passer les paramètres <em>ecosystem, keyID, roleID, isMobile</em>. Pour recevoir des pages d'autres écosystèmes, l'ID de l'écosystème doit être préfixé au nom de la page. Par exemple : <code>@2mapage</code>.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content/hash/default </code></pre></div><ul><li><p><code>name</code></p> <blockquote><p>Le nom de la page avec l'identifiant de l'écosystème.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>Identifiant de l'écosystème.</p></blockquote></li> <li><p><code>keyID</code></p> <blockquote><p>Adresse du compte.</p></blockquote></li> <li><p><code>roleID</code></p> <blockquote><p>Identifiant du rôle.</p></blockquote></li></ul> <p><strong>Réponse</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>Hachage hexadécimal.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_NOTFOUND, E_SERVER, E_HEAVYPAGE</em></p> <h3 id="content"><a href="#content" class="header-anchor">#</a> content </h3> <p><strong>POST</strong></p> <p>Renvoie le nombre d'objets JSON pour le code de la page à partir du paramètre <strong>template</strong>, si le paramètre optionnel <strong>source</strong> est spécifié comme <code>true ou 1</code>, alors cet arbre d'objets JSON ne réalise aucune fonction et ne reçoit pas de données.</p> <p>Cet arbre d'objets JSON peut être utilisé dans le concepteur de pages visuelles.</p> <p>Cette requête ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <ul><li><p><code>template</code></p> <blockquote><p>Code de la page.</p></blockquote></li> <li><p><code>source</code></p> <blockquote><p>Si <code>true or 1</code> est spécifié, l'arbre d'objets JSON n'exécute aucune fonction et reçoit des données.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/content </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>tree</code></p> <blockquote><p>Arbre d'objet JSON.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_NOTFOUND, E_SERVER</em></p> <h3 id="maxblockid"><a href="#maxblockid" class="header-anchor">#</a> maxblockid </h3> <p><strong>GET</strong>/ Retourne l'ID du bloc le plus élevé sur le nœud actuel.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/maxblockid </code></pre></div><p><strong>Réponse</strong></p> <ul><li><p><code>max_block_id</code></p> <blockquote><p>Le plus haut identifiant de bloc sur le nœud actuel.</p></blockquote></li></ul> <p><strong>Exemple de réponse</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>Réponse d'erreur</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="block-id"><a href="#block-id" class="header-anchor">#</a> block/{id} </h3> <p><strong>GET</strong>/ Retourne des informations sur l'identifiant de bloc spécifié.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>Identifiant de bloc.</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>Réponse</strong></p> <ul><li><p><code>hash</code></p> <blockquote><p>Hash du bloc.</p></blockquote></li> <li><p><code>key_id</code></p> <blockquote><p>L'adresse du compte qui a signé le bloc.</p></blockquote></li> <li><p><code>time</code></p> <blockquote><p>Horodatage de génération du bloc.</p></blockquote></li> <li><p><code>tx_count</code></p> <blockquote><p>Nombre total de transactions dans le bloc.</p></blockquote></li> <li><p><code>rollbacks_hash</code></p> <blockquote><p>Hash de rollback du bloc.</p></blockquote></li> <li><p><code>node_position</code></p> <blockquote><p>La position du bloc dans la liste des nœuds honorés.</p></blockquote></li></ul> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: application/json { "hash": "1x4S5s/zNUTopP2YK43SppEyvT2O4DW5OHSpQfp5Tek=", "key_id": -118432674655542910, "time": 1551145365, "tx_count": 3, "rollbacks_hash": "47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=", "node_position": 0, } </code></pre></div><p><strong>Réponse d'erreur</strong></p> <p><em>E_NOTFOUND</em></p> <h3 id="avatar-ecosystem-member"><a href="#avatar-ecosystem-member" class="header-anchor">#</a> avatar/{ecosystem}/{member} </h3> <p><strong>GET</strong>/ Retourne l'avatar de l'utilisateur dans la table <em>member</em> (disponible sans connexion).</p> <p><strong>Demande</strong></p> <ul><li><p><code>ecosystem</code></p> <blockquote><p>Identifiant de l'écosystème.</p></blockquote></li> <li><p><code>member</code></p> <blockquote><p>L'adresse du compte de l'utilisateur. (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>Réponse</strong></p> <p>L'en-tête de requête <em>Content-Type</em> est le type d'image et les données de l'image sont renvoyées dans le corps de la réponse.</p> <p><strong>Exemple de réponse</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>200 (OK) Content-Type: image/png </code></pre></div><p><strong>Réponse d'erreur</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>/ Retourne l'adresse hôte et le port de centrifugo.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <div class="language-text extra-class"><pre class="language-text"><code>GET /api/v2/config/centrifugo </code></pre></div><p><strong>Réponse</strong></p> <p>Format de résultat de réponse <code>http://adresse:port</code>, par exemple : <code>http://127.0.0.1:8100</code>.</p> <p><strong>Réponse d'erreur</strong></p> <p><em>E_SERVER</em></p> <h3 id="updnotificator"><a href="#updnotificator" class="header-anchor">#</a> updnotificator </h3> <p><strong>POST</strong>/</p> <p>(Mis au rebut)</p> <p>Envoie tous les messages qui n'ont pas encore été envoyés au service de notification Centrifugo. Envoie uniquement les messages pour l'écosystème et les membres spécifiés.</p> <p>Cette demande ne nécessite pas d'autorisation de connexion.</p> <p><strong>Demande</strong></p> <ul><li><p><code>id</code></p> <blockquote><p>Adresse du compte du membre.</p></blockquote></li> <li><p><code>ecosystem</code></p> <blockquote><p>Identifiant de l'écosystème.</p></blockquote></li></ul> <div class="language-text extra-class"><pre class="language-text"><code>POST /api/v2/updnotificator </code></pre></div><p><strong>Exemple de réponse</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> Instructions spéciales </h3> <h4 id="omitempty"><a href="#omitempty" class="header-anchor">#</a> Omitempty </h4> <p>Si le champ a un attribut omitempty, cela signifie que le champ est un paramètre facultatif.</p> <h4 id="authorization"><a href="#authorization" class="header-anchor">#</a> Authorization </h4> <p>Si l'interface a une balise d'autorisation, cela signifie que cette interface nécessite une autorisation de connexion. Veuillez ajouter l'autorisation à l'en-tête de la requête. Voici un exemple :</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/fr/reference/api2.md" target="_blank" rel="noopener noreferrer">Modifier cette page sur 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">Dernière mise à jour:</span> <span class="time">06/07/2023 18:59:03</span></div></footer> <div class="page-nav"><p class="inner"> <span class="next"><a href="/fr/reference/platform-parameters.html"> Paramètres de la plateforme </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/56.d2b06c81.js" defer></script> </body> </html>