DCore API接口说明

最新推荐文章于 2024-05-26 09:45:55 发布
最新推荐文章于 2024-05-26 09:45:55 发布
阅读量700 收藏
点赞数
分类专栏： # DCore API 接口说明 文章标签： DCore区块链 API Daemon(守护者进程) CLI命令行
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44737852/article/details/89884172
版权

在这里插入图片描述

DCore API接口说明

本篇文档会向DCore的开发者或集成者介绍DCore的应用程序接口（API）。

访问以下链接，您可以浏览所有的API接口。

API接口架构

根据API接口来源，主要划分为两种。

  • Daemon API - 调用此接口需连接到运行中的Daemon(守护者进程)（decentd）。
  • Wallet API - 钱包API接口 – 调用此接口需连接到运行中的CLI命令行钱包。

守护者进程API接口分为以下接口组件：

  • 登录 - 包含login和enable_api组件。这是唯一不需要提前调用enable_api就可以使用的API接口组件（连同database API一起）。其他所有的接口组件都需要通过提前调用enable_api，才能够调用并获取接口id。id的作用是调用特殊组件中所有的API接口。接下来的API调用事例中会详细解释该操作。
  • 数据库 - 包含可从全节点数据库接收信息的API接口，例如交易目标、交易、区块、账户、财产等信息。
  • 交易历史 - 包含提供交易历史的API接口。
  • 网络广播 - 包括广播至全网的API接口。
  • 网络节点 - 包含获取或变更点对点网络设置的API接口。
  • 加密 - 包含签名和进行验证的API接口。
  • 消息传送 - 包含发送和接收消息的API接口。
    钱包API接口不包含API接口组件。
通讯协议

用于API接口调用的通讯协议是HTTP和Websocket。两者的主要差异是HTTP协议不会保持会话状态，所以我们只能调用守护者进程 （Daemon API）内的数据库 （database）API接口组件中的一个。钱包API组件 （Wallet API）既可以通过Websocket调用，也可以通过HTTP调用，因为运行中的CLI钱包程序可以为每一次连接保留会话数据。

我们首先会展示一些使用Websocket协议的实例，之后会展示使用HTTP协议的实例。

使用Websocket协议的先决条件

以下指南为API接口组件的测试环境提供了简易的安装程序。

为了通过Websocket协议调用daemon或钱包API接口，您需要：
• 运行decentd （decentd也被称为daemon）
• 运行适合Websocket协议连接的CLI钱包（仅限钱包API接口）
• 安装wscat应用程序

该测试环境在Linux，MacOS和Windows操作系统上均可安装。关于如何运行decentd和CLI钱包的说明请访问： https://docs.decent.ch/API/#calling_dcore_daemon_api_via_websocket

安装wscat：

npm install -g wscat

提示
如果尚未安装NPM，您可以从Node.js webpage下载

通过Websocket 调用 DCore守护者进程API接口

运行守护者进程API接口的测试环境
执行decentd开启DCore守护者进程

./decentd

连接Websocket协议至DCore daemon：

wscat -c ws://127.0.0.1:8090
登录API接口

为从任意应用API组件中成功调用所有API接口，请首先调用登录API接口（可在登录组件当中找到），此接口会默认被激活。

注意
• 不是所有的API接口组件都能够在每个实例中激活（为安全起见，网络节点（network_node）只能在daemon中被激活，并可以配置连接到API接口组件）。
• 其他在上面表单当中提到的API接口组件可以进行任意连接。

API组件调用JSON架构

  • id - call_id（API接口调用的识别码，可对需求进行匹配）

  • method - call - 调用API接口的命令

  • params- [ apiset_id,api_name,[ list_of_params]]

  • 第一个参数 apiset_id为API接口组件的账户

  • 第二个参数 api_name为需要调用的API接口的名称

  • 第三个参数[ list_of_params]是特殊API接口的参数列表，任意参数也可以成为一个独立数值列表，如此一来，列表就被嵌套在括号当中。

调用 - login api：

{"id":1,"method":"call","params":[1,"login",["",""]]}

回应：

{"id":1,"result":true}

说明
通过把 apiset_id 设为1调用 login API 组件 。这个数值被定义为默认值，并且为恒定值。

登录API接口的开发者文档

激活特殊API接口组件

若要激活特殊API接口组件需要调用enable_api。此API接口来自登录API接口组件，并且此接口默认为可获得。

调用 - 激活数据库API接口组件：

{"id":1,"method":"call","params":[1,"database",[]]}

回应：

{"id":1,"result":2}

若可连接API接口组件，组件的成员名称，也就是id，会以名称结果的数值返回（之前的事例当中，名称结果的数值为2）。目前，此id适用于任意数据库API接口的所有调用（作为apiset_id，params中的第一个参数）。请注意，此id可以区分于所有的连接（取决于激活API接口组件的命令）。

通知
还有另外一种可能，能够在不需要调用登录API接口就能够直达数据库API接口组件。为此，可以使用 call login example 的调用框架并且作出以下变更：
• apiset_id数值更换为0
• apiset_name的数值更换为database

数据库API接口的开发者文档

激活API接口组件调用API接口
我们假设，选中的API接口是获取账户余额（get_account_balances）的接口，我们想要通过id=1.2.21的账户看到其中的余额。由于此API接口属于数据库API接口组件，我们已经有了接口组件，也就是id = 2，所以正确的调用方式为：

调用 - （get_account_balances） api：

{"id":1,"method":"call","params":[2,"get_account_balances",["1.2.21",[]]]}

回应：

{"id":1,"result":[{"amount":"15400490000","asset_id":"1.3.0"}]}

获取账户余额API接口的开发者文档

另外一个通过组件调用API的例子为：从交易历史API接口组件中的获取账户历史（get_account_history）。

调用 - 激活交易历史API接口组件：

{"id":1,"method":"call","params":[1,"history",[]]}

回应：

{"id":1,"result":3}

请注意：
所有API接口组件的激活只需调用一次

历史API接口的开发者文档档

成员名称结果的返回数值被用于获取账户历史（get_account_history）调用的API接口组件id。例如，我们通过调用id = 1.2.21查看账户的最后两笔历史记录。

调用 - 获取账户历史（get_account_history）api：

{"id":1,"method":"call","params":[3,"get_account_history",["1.2.21","1.7.1",2,"1.7.1212121"]]}

回应（历史记录表单）：

{
  "id": 1,
  "result": [
    {
      "id": "1.7.38270",
      "op": [
        1,
        {
          "fee": {
            "amount": 500000,
            "asset_id": "1.3.0"
          },
          "registrar": "1.2.21",
          "name": "myaccount",
          "owner": {
            "weight_threshold": 1,
            "account_auths": [
            ],
            "key_auths": [
              [
                "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
                1
              ]
            ]
          },
          "active": {
            "weight_threshold": 1,
            "account_auths": [
            ],
            "key_auths": [
              [
                "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
                1
              ]
            ]
          },
          "options": {
            "memo_key": "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
            "voting_account": "1.2.3",
            "num_miner": 0,
            "votes": [
            ],
            "extensions": [
            ],
            "allow_subscription": false,
            "price_per_subscribe": {
              "amount": 0,
              "asset_id": "1.3.0"
            },
            "subscription_period": 0
          },
          "extensions": {
          }
        }
      ],
      "result": [
        1,
        "1.2.4143"
      ],
      "block_num": 702030,
      "trx_in_block": 0,
      "op_in_trx": 0,
      "virtual_op": 37303
    },
    {
      "id": "1.7.37253",
      "op": [
        1,
        {
          "fee": {
            "amount": 500000,
            "asset_id": "1.3.0"
          },
          "registrar": "1.2.21",
          "name": "myaccount",
            "owner": {
            "weight_threshold": 1,
            "account_auths": [
            ],
            "key_auths": [
              [
                "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
                1
              ]
            ]
          },
          "active": {
            "weight_threshold": 1,
            "account_auths": [
            ],
            "key_auths": [
            [
                "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
                1
              ]
            ]
          },
          "options": {
            "memo_key": "DCT66RkRV5vpanRc7iAXdFyAMwFTbmLHCUe9eBB6aQjaHkrTZfBHL",
            "voting_account": "1.2.3",
            "num_miner": 0,
            "votes": [
            ],
            "extensions": [
            ],
            "allow_subscription": false,
            "price_per_subscribe": {
              "amount": 0,
              "asset_id": "1.3.0"
            },
            "subscription_period": 0
          },
          "extensions": {
          }
        }
      ],
      "result": [
        1,
        "1.2.4142"
      ],
      "block_num": 701189,
      "trx_in_block": 0,
      "op_in_trx": 0,
      "virtual_op": 37286
    }
  ]
}

获取账户历史API接口的开发者文档(https://docs.decent.ch/developer/group___history_a_p_i.html#ga2bfce814ce4adde1c30e63662f3fa18c

通过Websocket调用钱包API接口

为钱包运行测试环境
执行decentd开启DCore daemon

./decentd

在默认端口运行适用于Websocket连接的CLI钱包

cli_wallet -r

wscat -c ws://127.0.0.1:8091

将Websocket协议连接至CLI钱包

wscat -c ws://127.0.0.1:8091
调用钱包API接口

根据特殊API接口详细说明，通过设置数值 - method和 params调用应用程序接口。请注意，params数值是括号当中params的列表数值。 id数值可以为任意值，用于匹配调用及其返回的数值。

调用格式：

{
  "jsonrpc": "2.0",
  "id": "call_id",
  "method": "api_name",
  "params": ["param_1", "param_2", "...", "param_N"]
}

这其中的参数为：
• id - 任意识别API接口调用的数字都会出现在JSON回应中。
• - method - 被调用API接口的全名。
• params - 是特殊API接口的参数列表，任意参数也可以成为一个独立数值列表，这样，列表就被嵌套在括号当中。

钱包API接口的开发者文档

举例说明， unlock API接口在文档中被定义为：

public void unlock(string password)

因此，Websocket 调用定义为：
调用 - unlock api:

{"jsonrpc":"2.0","id":1,"method":"unlock","params":["myUnlockPwd"]}

回应：

{"id":1,"result":null}

Unlock API接口的开发者文档

另一个实例为获取账户（get_account）
调用 - （get_account） api：

{"jsonrpc":"2.0","id":1,"method":"get_account","params":["1.2.21"]}

回应：

{
  "id": 1,
  "result": {
    "id": "1.2.21",
    "registrar": "1.2.20",
    "name": "decent-go",
    "owner": {
      "weight_threshold": 1,
      "account_auths": [
      ],
      "key_auths": [
        [
          "DCT8gwQkHXNYgHp1kzo56oZCLdrm3qV99xN15yeE1QhBcbAYsMDZy",
          1
        ]
      ]
    },
    "active": {
      "weight_threshold": 1,
      "account_auths": [
      ],
      "key_auths": [
        [
          "DCT8gwQkHXNYgHp1kzo56oZCLdrm3qV99xN15yeE1QhBcbAYsMDZy",
          1
        ]
      ]
    },
    "options": {
      "memo_key": "DCT8gwQkHXNYgHp1kzo56oZCLdrm3qV99xN15yeE1QhBcbAYsMDZy",
      "voting_account": "1.2.3",
      "num_miner": 0,
      "votes": [
      ],
      "extensions": [
      ],
      "allow_subscription": false,
      "price_per_subscribe": {
        "amount": 0,
        "asset_id": "1.3.0"
      },
      "subscription_period": 0
    },
    "rights_to_publish": {
      "is_publishing_manager": false,
      "publishing_rights_received": [
      ],
      "publishing_rights_forwarded": [
      ]
    },
    "statistics": "2.5.21",
    "top_n_control_flags": 0
  }
}

获取账户API接口的开发者文档

通过HTTP调用DCore守护者进程API接口

运行DCore守护者进程
通过执行decentd开启DCore守护者进程

./decentd
调用数据库应用程序接口

若通过Websocket协议调用，所有应用程序接口调用都有相同的数据结构。

数据库应用程序接口的开发者文档

举例说明，我们会用一个账户 id参数 1.2.69来调用获取账户 （get_accounts）应用程序接口。

HTTP需求 - 获取账户（get_accounts）api：

curl --data '{"jsonrpc":"2.0","id":1,"method":"get_accounts","params":[["1.2.69"]]}' http://127.0.0.1:8090/rpc

回应：

{
  "id": 1,
  "result": [
    {
      "id": "1.2.69",
      "registrar": "1.2.15",
      "name": "ronald",
      "owner": {
        "weight_threshold": 1,
        "account_auths": [
        ],
        "key_auths": [
          [
            "DCT8SFcioQFYXnNHNSAEcLb5o5EovrhjPk4SMbYnag6t6VhwuvMAc",
            1
          ]
        ]
      },
      "active": {
        "weight_threshold": 1,
        "account_auths": [
        ],
        "key_auths": [
          [
            "DCT8SFcioQFYXnNHNSAEcLb5o5EovrhjPk4SMbYnag6t6VhwuvMAc",
            1
          ]
        ]
      },
      "options": {
        "memo_key": "DCT8SFcioQFYXnNHNSAEcLb5o5EovrhjPk4SMbYnag6t6VhwuvMAc",
        "voting_account": "1.2.3",
        "num_miner": 0,
        "votes": [
          "0:1",
          "0:11"
        ],
        "extensions": [
        ],
        "allow_subscription": true,
        "price_per_subscribe": {
          "amount": 100000000,
          "asset_id": "1.3.0"
        },
        "subscription_period": 7
      },
      "rights_to_publish": {
        "is_publishing_manager": false,
        "publishing_rights_received": [
        ],
        "publishing_rights_forwarded": [
        ]
      },
      "statistics": "2.5.69",
      "top_n_control_flags": 0
    }
  ]
}

获取账户应用API的开发者文档

通过HTTP调用钱包API接口

运行DCore Daemon和钱包

通过执行decentd开启DCore daemon:

./decentd

在默认端口运行适用于Websocket连接的CLI钱包：

cli_wallet -H
钱包API接口调用实例

钱包API接口调用的数据结构不论通过HTTP协议还是通过Websocket协议都是一样的。

以下为调用 unlock API接口的实例

钱包命令：

locked >>> unlock myPassword

HTTP需求 - unlock api：

curl --data '{"jsonrpc":"2.0","id":1,"method":"unlock","params":["myPassword"]}' http://127.0.0.1:8093/rpc

回复

{
  "id": 1,
  "result": null
}

解锁钱包API接口的开发者文档

一旦钱包解锁，我们就能够调用，比如一个简单的DCT交易。
钱包命令:

transfer fromAccount toAccount 1 DCT "note" true

HTTP 需求- transfer api：

curl --data '{"jsonrpc":"2.0","id":1,"method":"transfer","params":["fromAccount" "mictoAccountkey" "1" "DCT" "nate" "true"]}' http://127.0.0.1:8093/rpc

回应：

{
  "id": 1,
  "result": {
    "ref_block_num": 43971,
    "ref_block_prefix": 4115917218,
    "expiration": "2018-01-16T09:53:15",
    "operations": [
      [
        0,
        {
          "fee": {
            "amount": 500000,
            "asset_id": "1.3.0"
          },
          "from": "1.2.69",
          "to": "1.2.73",
          "amount": {
            "amount": 100000000,
            "asset_id": "1.3.0"
          },
          "memo": {
            "from": "DCT8SFcioQFYXnNHNSAEcLb5o5EovrhjPk4SMbYnag6t6VhwuvMAc",
            "to": "DCT5yt9cuR2d6UDmtQQZBckT4eNJ3u9fmmWnBfiBEgqz1PnQyzHqD",
            "nonce": "3964683768455640627",
            "message": "5ccbbb3b98a916ef7bc60c8aff06198a"
          },
          "extensions": [
          ]
        }
      ]
    ],
    "extensions": [
    ],
    "signatures": [
      "1f7e2844d458182ac9490accdda00e61c47ac416bda9502c758dae0cbb3b3603ff70d32c019c5a23bef8944be8ad7c7d2a5f8080f41159a5c483593c51973ad535"
    ]
  }
}

钱包交易API的开发者文档

DECENTplatform
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
《Linux系统调用： daemon》
yexiangCSDN的专栏
08-22 388
一、程序 #include <stdio.h> #include <unistd.h> #include <stdlib.h> #include <time.h> #include <fcntl.h> #include <string.h> #include <sys/stat.h> #include <...
【DRF配置管理】如何建立coreapi风格接口文档
黎明总是如期而至
04-25 929
DRF广泛的应用于django网络开发，尤其是在前后端分离的项目中，与vue、react等框架结合使用。本篇博客单独介绍DRF自带接口文档的使用。自定义参数需要我们自己设置，主要用于list(getall)的查询和文件下载。views.py文件"""list:下载文件：kml"""# 认证# docs文档参数description='下载文件：kml',fields=[schema=coreschema.Integer(description="历史区域主键id")),
探索Core API：构建动态Web API的利器
最新发布
gitblog_00087的博客
05-26 398
探索Core API：构建动态Web API的利器 项目地址:https://gitcode.com/core-api/core-api Core API是一个独立于格式的文档对象模型(Document Object Model)，专为表示Web API设计。它不仅可以处理**模式(Schema)响应，还能处理超媒体(Hypermedia)**响应，让您从应用程序接口层而非网络接口层与API交互。...
Django_coreapi生成接口文档(djangorf的，写注释更方便）
Ataoker的博客
07-10 524
在urls.py 中添加文档路径, (在外层url文件，或应用内的都行)模型中定义的verbose_name 和 help_text 也会被用到。另一种方式，三个字符串注释，写在方法下面（优先级更优先）在settings.py文件中。
什么是api接口？（基本介绍）
Merissa_的博客
02-27 2588
这些优秀可视化编程环境操作简单、界面友好(诸如VB、VC++、DELPHI等)，在这些工具中提供了大量的类库和各种控件，它们替代了API的神秘功能，事实上这些类库和控件都是构架在WIN32 API函数基础之上的，是封装了的API函数的集合。，必然要涉及到直接使用API函数，虽然类库和控件使应用程序的开发简单的多，但它们只提供WINDOWS的一般功能，对于比较复杂和特殊的功能来说，使用类库和控件是非常难以实现的，这时就需要采用API函数来实现。间的小型格式化信息，通过程序间的直接通信实现数据共享。
什么是API接口？API接口的用途以及详细示例说明。
APItesterCris的博客
03-29 3361
因此，除了具备执行数据共享任务所需的知识以外，这些类型的 API 还必须解决很多网格参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。简单一点来说就是通过API接口可以实现计算机软件之间的相互通信，开发人员可以通过API接口程序开发应用程序，可以减少编写无用程序,减轻编程任务，API 同时也是一种中间件， 为各种不同平台提供数据共享。标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。参数说明：sku_id:SKU ID。
j3dcore-ogl.dll
09-05
j3dcore-ogl.dll用于Exception in thread "main" java.lang.UnsatisfiedLinkError: no j3dcore-ogl in java.library.path错误的时候使用,下载后请把文档复制到JAVA\JDK\bin的目录下面即可
dcore个人网站微型CMS系统
03-25
　丰富的模板标签系统和详细的说明文档。 　同步生成静态页面，支持多种静态化策略。 Dcore网站管理手册：http://xunzong.net/dingjun/html/20/C689C1D0E3B9CCC3.html Dcore模板标签参考手册：...
Dcore轻型cms建站系统
03-25
　丰富的模板标签系统和详细的说明文档。 　同步生成静态页面，支持多种静态化策略。 Dcore网站管理手册：http://xunzong.net/dingjun/html/20/C689C1D0E3B9CCC3.html Dcore模板标签参考手册：...
dCore-开源
05-15
dCore是一个应用程序框架。 dCore包含用户，内容和文件管理系统。 dCore由专家Duncan Cameron编写。 扩展是通过添加模板和模块。 通过http://www.dcoreapp.co下载最新版本
RESTFul API 接口说明
11-05
restful api 接口说明. 总结 restful api 语法知识和常用的状态码含义.
qv-api-gd：游戏发行服务模块
02-15
@ byqv / qv-api-gd 游戏微服务可以连接到Game Distribution API
CoreApi
03-11
CoreApi
FiddlerCoreApi说明文档
12-19
FiddlerCoreApi说明文档，很详细地介绍了FiddlerCore中的类和函数。
dcore 轻型内容管理系统 v1.0
03-17
　丰富的模板标签系统和详细的说明文档。 　同步生成静态页面，支持多种静态化策略。 Dcore网站管理手册：http://xunzong.net/dingjun/html/20/C689C1D0E3B9CCC3.html Dcore模板标签参考手册：...
coreapi自动生成API接口文档
go|Python的个人博客
03-14 1306
文章目录1 安装：2 在路由中配置视图中使用方法 1 安装： pip install coreapi 2 在路由中配置 from rest_framework.documentation import include_docs_urls urlpatterns = [ ... path('docs/', include_docs_urls(title='站点页面标题')) ] 新版本需要在配置文件中配置: REST_FRAMEWORK={ 'D
.net core请求外部api接口
热门推荐
你要明白，任何问题都不是孤立存在的，一定有人曾经遇到过，并且已经有更好的解决办法了，只是我还不知道。我不应该在黑暗中独自前行，去重新发明轮子，也许我的顿悟，只是别人的基本功！我应该要站在巨人的肩膀上，学习更成熟的经验和方法，然后再来解决这个问题
01-14 1万+
1、打开net core项目中的Startup.cs文件，找到ConfigureServices方法，添加HttpClient services.AddHttpClient();//注入httpclient 用于调用外部api 2.控制器中注入IHttpClientFactory using System.Net.Http; private IHttpClientFactory _httpClient; public WeChatController( IHttp
「API接口的技术说明文档
2303_76945341的博客
05-24 927
API技术文档是API的核心之一，应该是有条理、简介、一致的，以使得API的使用变得更加容易且可靠。API技术文档是API的唯一方法，以便开发人员和其他用户快速理解API的所有方面。它提供了不同的API用例和示例，帮助开发人员更快地集成API，避免和错误集成，同时提高了开发人员的效率。它详细描述了API端点，资源，参数，请求和响应格式以及使用API的常见用例和最佳实践。API技术文档应该定期更新，以便反映最新的API变更。最佳实践和示例：提供使用API的最佳实践和示例，以帮助开发人员更好地使用API。
Qt3DCore::QEntity 的实体加上旋转动画
06-07
要给 Qt3DCore::QEntity 的实体加上旋转动画，可以使用 Qt3DAnimation 模块中的 QPropertyAnimation 类。首先需要在代码中创建一个 QPropertyAnimation 对象，设置其目标属性为 Qt3DCore::QTransform 中的 rotation ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值