iotachina
IOTA api

Updated 4 months ago

IOTA API简介

IOTA Java客户端让我们可以和本地节点交互,并且可以请求某些信息或者操作。当你的节点完全建立之后,可通过端口14265传入包含某一命令的JSON对象来交互;一旦命令成功执行,将返回你请求的信息。 API和IRI本身的最高优先级是安全。因此任何和私钥有关的操作都是由客服端来执行。我们提供了一些库来处理这些操作,当然你也可以自己实现这些功能。 为了方便,我们添加了具体的例子,包括如何用cURL,Python,NodeJS来调用API。如果你使用Javascript,可以依照XMLHttpRequest或者jQuery的使用方式。对于NodeJS,请安装npm request包,因为我们所有的例子都需要request包。 本文的余下部分,假设你的IOTA客户端运行在14265端口(或者你自己选择的其他端口,修改对应的地方就行了)。

发起请求

所有的API调用需要通过发送HTTP POST请求到http://localhost:24265(如果使用的是标准端口的话)。发送的数据是JSON对象,遵从下面相同标准的格式:

  {‘command’: ’YOURCOMMANDHERE’}

额外的参数可以简单的按照键值对来添加。如果命令成功执行,返回的请求的信息是一个对象或者字符串化后的对象(使用json.parse或者其他方式可以转化成一个对象)。 当发送请求时,确保使用的HTTP库定义了发送数据的Content-Length。如果没有自动定义,需要手动通过添加header字段来添加,如'Content-Length': Buffer.byteLength(JSON.stringify(command))

CORS

CORS有效 进行中

Errors

进行中

字段

这里我们列举和描述了传给某个命令所需的所有额外参数。

  • seed: string 包含账户种子的tryte编码的字符串。种子必须是正确编码的trytes:只能是大写拉丁字符和数字9,不允许其他字符。最高安全等级是81个trytes字符,但是你可以选择更长/更短的种子。
  • address:string 交易接收地址的81 trytes字符长度的地址。value:被转移的IOTA数量对应的字符串。
  • message:string tryte编码的字符串,可以跟随交易一起发送的任意信息。消息值是公开可见的。最大值是2187个trytes字符,即6561 trits(或大致1312个字节)。
  • transaction / hash:string 交易的哈希值。一个交易的哈希值是81字符长。
  • trytes:string 交易的原始数据。
  • bundles:list 包含交易bundles的集合。bundles是连接的,单一的由单个交易者创建的交易。它们由一个27字符长的哈希唯一标识。
  • addresses:list 一系列地址的集合。单个地址是81字符长。
  • tags:list 交易的标签。
  • approvees:list 本交易引用的一系列交易集合。
  • securityLevel:int 指定了交易的安全等级。可以是0(81-trit安全度),1(162-trit安全度)和2(243-trit安全度)。低安全级别的交易可以更快的生成。
  • minWeightMagnitude:int 指定执行的工作量证明的数量。当前只能接受18。