文档

开始使用REST服务

更新时间:

REST是蚂蚁链BaaS平台官方提供的接入服务,目标是为上层区块链应用提供易用、高效、可靠的统一区块链接入服务。

REST 功能简介

REST提供合约管理、账户管理、合约交易、存证交易、区块查询等蚂蚁链常用交互功能,以及MYTF链下安全计算应用管理和应用执行操作功能,同时集成和利用蚂蚁生态中的区块链基础服务设施和核心技术能力,包括KMS和TEE,提供多种灵活的区块链访问方式,同步/异步调用,外部/内部签名,普通/私密交易。以下是BaaS REST 可靠上链的完整的功能示意图。1REST 接入服务的具体优势如下:

  • 标准化接口:跨编程语言标准的RESTful API接口。

  • 灵活性编程:支持同步调用、异步调用、主动轮询、异步消息、托管代签等模式。

  • 可靠性服务:幂等控制、可靠上链、可靠推送、异常重试、交易数据持久化,智能路由能够选择最优节点来发起上链交易。

  • 稳定性保障:限流降级、细粒度监控告警。

  • 安全性护航:AK/SK及访问令牌、TEE链加密交易

  • 高性能支撑:结合数据分片、水平扩容、交易缓冲等技术,具备日均10亿规模交易处理能力。

获取REST身份

说明

目前支持开通主链上的REST服务,子链暂不支持该功能。

开通主链REST功能

主链REST功能开通后,即可在链上获取AccessKey和Access-ID信息,调用REST接口时需要用到此信息,具体操作如下。

  1. 登录阿里云BaaS控制台,单击左侧导航栏蚂蚁区块链 > 合约链,进入我的联盟页。

  2. 选择目标联盟,并单击目标联盟所在行右侧操作栏下的管理,进入联盟内的链

  3. 单击目标联盟链上的 更多 > 获取REST身份,在获取REST身份的弹窗中单击REST身份即可下载AccessKey。

    主链10.1
  4. 在弹出的下载框中下载AccessKey。

    主链11.1
    重要

    AccessKey下载后,无法二次获取,若不慎丢失,请参见下方重置主链REST身份,以获取新的AccessKey。

  5. 查看Access-ID 下载AccessKey后,您可以单击更多 > 查看REST身份,进入Access-ID信息展示界面。

    主链12

重置主链REST身份

如果密钥不慎丢失,您可以单击更多 > 重置REST身份,重置后,您可以在获取REST身份的弹窗中,单击下载获取新的AccessKey。主链14

重置过程中,您需要发送验证码才能重置成功。

获取链ID

使用SDK参考或HTTP参考方式调用接口时,均需要提前获取区块链ID,获取方式如下。

  1. 登录阿里云BaaS控制台

  2. 单击左侧导航栏蚂蚁区块链 > 合约链,进入我的联盟页。

  3. 选择目标联盟,并单击目标联盟所在行右侧操作栏下的管理,进入联盟内的链

  4. 在列表下找到目标联盟链,区块链名称一栏中即可获取到该目标联盟链的bizid,即区块链ID。

    image.png您也可以单击操作栏中的查看按钮,在区块链浏览器页面的URL地址栏中,同样可以获取到bizid。

    1

Demo工程示例

  • Demo工程下载

    点此下载REST Demo工程

  • Demo工程简介

    代码工程包括:基于BaaS REST的SDK的账户托管模式的示例、账户非托管模式的示例、TEE链的示例以及直接访问REST接口的相关使用参数示例。

    下载demo工程后,请详细阅读README.md文件,该说明详细介绍了如何快速使用我们的Demo。