BigChainDB API 总结

柴宏浚

2023-12-01

BigchainDB API文档

参考文档: http://docs.bigchaindb.com/en/latest/installation/api/http-client-server-api.html

1.概览

path	type	说明
/api/v1/transactions/{transaction_id}	GET	根据交易id查询某个交易
/api/v1/transactions	GET	条件查询交易
/api/v1/transactions	POST	发送交易
-	-	-
/api/v1/outputs	GET	根据公钥查询output
-	-	-
/api/v1/assets	GET	查询asset数据
-	-	-
/api/v1/metadata	GET	查询metadata数据
-	-	-
/api/v1/validators	GET	查询validators数据
-	-	-
/api/v1/blocks/{block_height}	GET	根据块高查询block信息
/api/v1/blocks	GET	根据交易id查询块高

2.tansaction API

2.1 根据交易id查询某个交易

path：/api/v1/transactions/{transaction_id}
请求类型：GET
参数： {tansaction_id}：交易ID
例子
请求：

	GET http://127.0.0.1:9984/api/v1/transactions/4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317

返回参数：

	{
	  "asset": {
	    "data": {
	      "msg": "Hello BigchainDB!"
	    }
	  },
	  "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317",
	  "inputs": [
	    {
	      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCy4BR6gKaYT-tdyAGPPpknIqI4JYQQ-p2nCg3_9BfOI-15vzldhyz-j_LZVpqAlRmbTzKS-Q5gs7ZIFaZCA_UD",
	      "fulfills": null,
	      "owners_before": [
	        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
	      ]
	    }
	  ],
	  "metadata": {
	    "sequence": 0
	  },
	  "operation": "CREATE",
	  "outputs": [
	    {
	      "amount": "1",
	      "condition": {
	        "details": {
	          "public_key": "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD",
	          "type": "ed25519-sha-256"
	        },
	        "uri": "ni:///sha-256;PNYwdxaRaNw60N6LDFzOWO97b8tJeragczakL8PrAPc?fpt=ed25519-sha-256&cost=131072"
	      },
	      "public_keys": [
	        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
	      ]
	    }
	  ],
	  "version": "2.0"
	}

2.2 根据条件查询

path:/api/v1/transactions?asset_id={asset_id}&operation={CREATE|TRANSFER}&last_tx={true|false}
请求类型：GET
参数

参数	类型	是否必须	说明
asset_id	string	是	交易id
operation	string	否	可填 CREATE 或 TRANSFER。不填增则查询所有的包含该asset_id的全部的交易。
last_tx	string	是	可填true或false。true代表查询最后一次关于asset_id的交易信息，false返回全部(新参数，需要验证)

例子：

请求

GET http://127.0.0.1:9984/api/v1/transactions?operation=TRANSFER&asset_id=4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317

返回参数

[{
  "asset": {
    "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317"
  },
  "id": "79ef6803210c941903d63d08b40fa17f0a5a04f11ac0ff04451553a187d97a30",
  "inputs": [
    {
      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUAYRI8kzKaZcrW-_avQrAIk5q-7o_7U6biBvoHk1ioBLqHSBcE_PAdNEaeWesAAW_HeCqNUWKaJ5Lzo5Nfz7QgN",
      "fulfills": {
        "output_index": 0,
        "transaction_id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317"
      },
      "owners_before": [
        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
      ]
    }
  ],
  "metadata": {
    "sequence": 1
  },
  "operation": "TRANSFER",
  "outputs": [
    {
      "amount": "1",
      "condition": {
        "details": {
          "public_key": "3yfQPHeWAa1MxTX9Zf9176QqcpcnWcanVZZbaHb8B3h9",
          "type": "ed25519-sha-256"
        },
        "uri": "ni:///sha-256;lu6ov4AKkee6KWGnyjOVLBeyuP0bz4-O6_dPi15eYUc?fpt=ed25519-sha-256&cost=131072"
      },
      "public_keys": [
        "3yfQPHeWAa1MxTX9Zf9176QqcpcnWcanVZZbaHb8B3h9"
      ]
    }
  ],
  "version": "2.0"
},
{
  "asset": {
    "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317"
  },
  "id": "1fec726a3b426498147f1a1f19a92c187d551a7f66db4b88d666d7dcc10e86a4",
  "inputs": [
    {
      "fulfillment": "pGSAICw7Ul-c2lG6NFbHp3FbKRC7fivQcNGO7GS4wV3A-1QggUARCMty2JBK_OyPJntWEFxDG4-VbKMy853NtqwnPib5QUJIuwPQa1Y4aN2iIBuoqGE85Pmjcc1ScG9FCPSQHacK",
      "fulfills": {
        "output_index": 0,
        "transaction_id": "79ef6803210c941903d63d08b40fa17f0a5a04f11ac0ff04451553a187d97a30"
      },
      "owners_before": [
        "3yfQPHeWAa1MxTX9Zf9176QqcpcnWcanVZZbaHb8B3h9"
      ]
    }
  ],
  "metadata": {
    "sequence": 2
  },
  "operation": "TRANSFER",
  "outputs": [
    {
      "amount": "1",
      "condition": {
        "details": {
          "public_key": "3Af3fhhjU6d9WecEM9Uw5hfom9kNEwE7YuDWdqAUssqm",
          "type": "ed25519-sha-256"
        },
        "uri": "ni:///sha-256;Ll1r0LzgHUvWB87yIrNFYo731MMUEypqvrbPATTbuD4?fpt=ed25519-sha-256&cost=131072"
      },
      "public_keys": [
        "3Af3fhhjU6d9WecEM9Uw5hfom9kNEwE7YuDWdqAUssqm"
      ]
    }
  ],
  "version": "2.0"
}]

2.3 发送交易

path：/api/v1/transactions?mode={mode}
请求类型：POST
参数

参数	类型	是否必须	说明
mode	string	否	可选 `async`,`sync`,`commit`。默认为`async`。`async`:请求立即响应，在Tendermint请求BigchainDB服务器检查事务的有效性之前立即返回。`sync`:在Tendermint从BigchainDB Server获得有关交易有效性的响应后，HTTP响应将返回。`commit`:表示交易在提交到块中在返回响应。

例子：
请求：

POST http://127.0.0.1:9984/api/v1/transactions?mode=async

请求参数

{
  "asset": {
    "data": {
      "msg": "Hello BigchainDB!"
    }
  },
  "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317",
  "inputs": [
    {
      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCy4BR6gKaYT-tdyAGPPpknIqI4JYQQ-p2nCg3_9BfOI-15vzldhyz-j_LZVpqAlRmbTzKS-Q5gs7ZIFaZCA_UD",
      "fulfills": null,
      "owners_before": [
        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
      ]
    }
  ],
  "metadata": {
    "sequence": 0
  },
  "operation": "CREATE",
  "outputs": [
    {
      "amount": "1",
      "condition": {
        "details": {
          "public_key": "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD",
          "type": "ed25519-sha-256"
        },
        "uri": "ni:///sha-256;PNYwdxaRaNw60N6LDFzOWO97b8tJeragczakL8PrAPc?fpt=ed25519-sha-256&cost=131072"
      },
      "public_keys": [
        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
      ]
    }
  ],
  "version": "2.0"
}

返回参数：

{
  "asset": {
    "data": {
      "msg": "Hello BigchainDB!"
    }
  },
  "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317",
  "inputs": [
    {
      "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCy4BR6gKaYT-tdyAGPPpknIqI4JYQQ-p2nCg3_9BfOI-15vzldhyz-j_LZVpqAlRmbTzKS-Q5gs7ZIFaZCA_UD",
      "fulfills": null,
      "owners_before": [
        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
      ]
    }
  ],
  "metadata": {
    "sequence": 0
  },
  "operation": "CREATE",
  "outputs": [
    {
      "amount": "1",
      "condition": {
        "details": {
          "public_key": "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD",
          "type": "ed25519-sha-256"
        },
        "uri": "ni:///sha-256;PNYwdxaRaNw60N6LDFzOWO97b8tJeragczakL8PrAPc?fpt=ed25519-sha-256&cost=131072"
      },
      "public_keys": [
        "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
      ]
    }
  ],
  "version": "2.0"
}

3. output API

3.1 查询output数据

path：/api/v1/outputs
请求类型：GET
请求参数：

参数	类型	是否必须	说明
public_key	string	是	公钥
spent	string	否	可选 true 或false。如果不填改参数，返回该公钥下的所有output（未交易和交易）。true返回已经交易的output。false返回没有交易的output。

例子：
请求：

GET http://127.0.0.1:9984/api/v1/outputs?public_key=1AAAbbb...ccc&spent=true

返回参数

[
  {
    "output_index": 0,
    "transaction_id": "2d431073e1477f3073a4693ac7ff9be5634751de1b8abaa1f4e19548ef0b4b0e"
  }
]

4. asset API

4.1 查询asset数据

path：/api/v1/assets
请求类型：GET
请求参数：

参数	类型	是否必须	说明
search	string	是	查询参数
limit	int	否	查询结果返回的个数。不填此参数，则返回包含search的所有asset信息

例子
请求参数：

GET http://127.0.0.1:9984/api/v1/assets?search=bigchaindb&limit=2

返回参数：

[
    {
        "data": {"msg": "Hello BigchainDB 1!"},
        "id": "51ce82a14ca274d43e4992bbce41f6fdeb755f846e48e710a3bbb3b0cf8e4204"
    },
    {
        "data": {"msg": "Hello BigchainDB 2!"},
        "id": "b4e9005fa494d20e503d916fa87b74fe61c079afccd6e084260674159795ee31"
    },
]

5. metadata API

5.1 查询metadatat数据

path：/api/v1/assets
请求类型：GET
请求参数：

参数	类型	是否必须	说明
search	string	是	查询参数
limit	int	否	查询结果返回的个数。不填此参数，则返回包含search的所有metadata信息。（官网说默认0返回全部）待验证。

例子
请求参数：

GET http://127.0.0.1:9984/api/v1/metadata?search=bigchaindb&limit=2

返回参数：

[
    {
        "metadata": {"msg": "Hello BigchainDB 1!"},
        "id": "51ce82a14ca274d43e4992bbce41f6fdeb755f846e48e710a3bbb3b0cf8e4204"
    },
    {
        "metadata": {"msg": "Hello BigchainDB 2!"},
        "id": "b4e9005fa494d20e503d916fa87b74fe61c079afccd6e084260674159795ee31"
    },
]

6. Validators API

6.1 查询Validators数据

path：/api/v1/validators
请求类型：GET
例子

请求参数：

GET http://127.0.0.1:9984/api/v1/validators

返回参数：

[
    {
        "pub_key": {
             "data":"4E2685D9016126864733225BE00F005515200727FBAB1312FC78C8B76831255A",
               "type":"ed25519"
        },
        "power": 10
    },
    {
         "pub_key": {
               "data":"608D839D7100466D6BA6BE79C320F8B81DE93CFAA58CF9768CF921C6371F2553",
               "type":"ed25519"
         },
         "power": 5
    }
]

7. Blocks API

7.1 通过块高查询区块的数据

path：/api/v1/blocks/{block_height}
请求类型：GET
请求参数：

参数	类型	是否必须	说明
block_height	int	是	块高

例子
请求参数：

GET http://127.0.0.1:9984/api/v1/blocks/1

返回参数：

{
  "height": 1,
  "transactions": [
    {
      "asset": {
        "data": {
          "msg": "Hello BigchainDB!"
        }
      },
      "id": "4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317",
      "inputs": [
        {
          "fulfillment": "pGSAIDE5i63cn4X8T8N1sZ2mGkJD5lNRnBM4PZgI_zvzbr-cgUCy4BR6gKaYT-tdyAGPPpknIqI4JYQQ-p2nCg3_9BfOI-15vzldhyz-j_LZVpqAlRmbTzKS-Q5gs7ZIFaZCA_UD",
          "fulfills": null,
          "owners_before": [
            "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
          ]
        }
      ],
      "metadata": {
        "sequence": 0
      },
      "operation": "CREATE",
      "outputs": [
        {
          "amount": "1",
          "condition": {
            "details": {
              "public_key": "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD",
              "type": "ed25519-sha-256"
            },
            "uri": "ni:///sha-256;PNYwdxaRaNw60N6LDFzOWO97b8tJeragczakL8PrAPc?fpt=ed25519-sha-256&cost=131072"
          },
          "public_keys": [
            "4K9sWUMFwTgaDGPfdynrbxWqWS6sWmKbZoTjxLtVUibD"
          ]
        }
      ],
      "version": "2.0"
    }
  ]
}

7.2 通过块高查询区块的数据

path：/api/v1/blocks
请求类型：GET
请求参数：

参数	类型	是否必须	说明
transaction_id	string	是	交易id

例子
请求参数：

GET http://127.0.0.1:9984/api/v1/blocks?transaction_id=4957744b3ac54434b8270f2c854cc1040228c82ea4e72d66d2887a4d3e30b317

返回参数：

[
  1
]

BigChainDB API 总结

BigchainDB API文档

1.概览

2.tansaction API

2.1 根据交易id查询某个交易

2.2 根据条件查询

2.3 发送交易

3. output API

3.1 查询output数据

4. asset API

4.1 查询asset数据

5. metadata API

5.1 查询metadatat数据

6. Validators API

6.1 查询Validators数据

7. Blocks API

7.1 通过块高查询区块的数据

7.2 通过块高查询区块的数据

相关阅读

相关文章

相关问答

相关文档