lockchain-http

用于各种lockchain组件的即插即用http接口层。

API参考

此文档将迁移。

所有JSON有效载荷还包括一个error字段，当没有设置其他数据时，在发生错误时设置。

{
    "error": ["Prose error description", 5 /* error code*/ ],
    "data": {
        /* Whatever the data is – depending on endpoint */
    }
}

GET /api

获取有关此API端点的信息。信息以JSON格式接收，包括以下字段。

• verison：API版本
• providers：类型提供者的数组。这包括保险库和Body实现的具体细节。
• hostname：可选值，指定服务器名称
• supported：支持的客户端/ API组合列表，以元组形式编写。这些是由API提供者自动生成的

GET /{api version}/vault

获取系统已知保险库的列表，可能只返回一个值

• vaults：可用的保险库名称列表，可用于工作
• count：可用的保险库数量

PUT /{api version}/vault

创建新的保险库。有效载荷

• name：保险库名称
• location：保险库的位置，由实现细节决定

POST /{api version}/vault/{id}

更新现有保险库的元数据。如果不存在，将返回错误

DELETE /{api version}/vault/{id}

删除保险库；所有用户都注销后需要第二次事务来确认

GET /{api version}/vault/{vault id}/records/{record id}

从保险库获取特定记录。只有认证后才能使用

PUT /{api version}/vault/{vault id}/records

向保险库添加新的记录。只有认证后才能使用

POST /{api version}/vault/{vault id}/records/{record id}

更新现有记录内的数据。只有认证后才能使用

DELETE /{api version}/vault/{vault id}/records/{record id}

删除记录。只有认证后才能使用

GET /{api version}/users

获取可用用户列表

PUT /{api版本}/users

创建新用户

DELETE /{api版本}/users/{id}

删除用户。只有当以该用户身份认证时才可用。

将来，可能添加管理员用户（以及可能的权限层次结构）

PUT /{api版本}/authenticate

以特定用户身份进行认证

• username：要认证的用户
• password：用于认证的用户密码（不同于加密密码）

PUT /{api版本}/de-authenticate

用于结束活动会话。