{ "openapi": "3.1.0", "info": { "title": "Energy Mate API", "description": "

Quick Start

codedescription
NOTICE:Please return success to notify the notification server after successfully receives the callback request. After the notification server receiving success, the notification stops. Otherwise, the notification will be sent 10 times at the frequency of 0s/15s/30s/3m/10m/20m/30m/60m/3h/6h.
", "version": "0.1#641" }, "servers": [ { "url": "http://api.catfee.io", "description": "Generated server url" } ], "tags": [ { "name": "OPEN API SERVICE", "description": "API服务" } ], "paths": { "/v1/mate/open/basic/{address}": { "get": { "tags": [ "OPEN API SERVICE" ], "summary": "得到基础版地址信息", "operationId": "hostBasicGet", "parameters": [ { "name": "address", "in": "path", "description": "波场地址", "required": true, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } }, "put": { "tags": [ "OPEN API SERVICE" ], "summary": "设置基础版地址", "operationId": "hostBasic", "parameters": [ { "name": "address", "in": "path", "description": "波场地址", "required": true, "schema": { "type": "string" } }, { "name": "is_auto_closable", "in": "query", "description": "是否72小时未使用自动关闭,true:开启,false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "quota_mode", "in": "query", "description": "配额模式。UNLIMITED:不受配额限制；TRANSFER_QUOTA|ENERGY_QUOTA:通过配额进行限制,选择此模式，必须传递quota_count参数。详细信息参见波场伴侣文档", "required": true, "schema": { "type": "string", "enum": [ "UNLIMITED", "TRANSFER_QUOTA", "ENERGY_QUOTA" ] } }, { "name": "quota_count", "in": "query", "description": "配额次数", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "enable", "in": "query", "description": "是否开启,true:启动 false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "remark", "in": "query", "description": "备注", "required": false, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } }, "deprecated": true }, "delete": { "tags": [ "OPEN API SERVICE" ], "summary": "删除基础版地址", "operationId": "hostBasic_1", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XObject" } } } } } } }, "/v1/mate/open/basic": { "post": { "tags": [ "OPEN API SERVICE" ], "summary": "添加基础版地址", "operationId": "hostBasic_2", "parameters": [ { "name": "address", "in": "query", "description": "波场地址", "required": true, "schema": { "type": "string" } }, { "name": "quota_mode", "in": "query", "description": "配额模式:不受配额限制；TRANSFER_QUOTA|ENERGY_QUOTA:通过配额进行限制,选择此模式，必须传递quota_count参数。详细信息参见波场伴侣文档", "required": true, "schema": { "type": "string", "enum": [ "UNLIMITED", "TRANSFER_QUOTA", "ENERGY_QUOTA" ] } }, { "name": "quota_count", "in": "query", "description": "配额次数", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "expired_at", "in": "query", "description": "过期时间", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "is_auto_closable", "in": "query", "description": "是否72小时未使用自动关闭,true:开启,false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "idle_hours", "in": "query", "description": "闲置时间（小时）自动关闭", "required": false, "schema": { "type": "integer", "format": "int32", "default": 72, "minimum": 24 } }, { "name": "bandwidth_guarantee", "in": "query", "description": "是否开启带宽保护", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "remark", "in": "query", "description": "备注", "required": false, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/remark": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "备注", "operationId": "hostBasicRemark", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "remark", "in": "query", "description": "备注，长度小于64", "required": true, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/quota/increment": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "增加或减少配额数量", "operationId": "hostBasicQuotaIncrement", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "count", "in": "query", "description": "配额数量", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/quota": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "修改配额模式与数量", "operationId": "hostBasicQuotaModel", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "mode", "in": "query", "description": "模式,UNLIMITED|TRANSFER_QUOTA|ENERGY_QUOTA", "required": true, "schema": { "type": "string", "enum": [ "UNLIMITED", "TRANSFER_QUOTA", "ENERGY_QUOTA" ] } }, { "name": "reset_used_count", "in": "query", "description": "是否重置已使用额度(当值为true,used_count重新计数,记录quota_start_time)", "required": true, "schema": { "type": "boolean" } }, { "name": "count", "in": "query", "description": "配额数量(mode=TRANSFER_QUOTA|ENERGY_QUOTA时有效,不能小于used_count)", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/expire": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "设置/取消过期", "operationId": "hostBasicExpire", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "at", "in": "query", "description": "过期时间(ISO8601 UTC时间，格式同 CF-ACCESS-TIMESTAMP)", "required": false, "schema": { "type": "string" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/enable": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "启动/暂停", "operationId": "hostBasicEnable", "parameters": [ { "name": "address", "in": "path", "description": "波场地址", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "true:开启，false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/bandwidth-guarantee": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "带宽保护", "operationId": "bandwidthGuarantee", "parameters": [ { "name": "address", "in": "path", "description": "地址", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "true:开启，false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } }, "/v1/mate/open/basic/{address}/auto-close": { "patch": { "tags": [ "OPEN API SERVICE" ], "summary": "自动关闭", "operationId": "hostBasicAutoClose", "parameters": [ { "name": "address", "in": "path", "description": "波场地址", "required": true, "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "true:开启，false:关闭", "required": true, "schema": { "type": "boolean" } }, { "name": "idle_hours", "in": "query", "description": "闲置时间（小时)，超过闲置时间未使用自动关闭，仅当value=true生效", "required": false, "schema": { "type": "integer", "format": "int32", "default": 72, "minimum": 24 } }, { "name": "CF-ACCESS-KEY", "in": "header", "description": "The API Access key as a string \nAPI所使用的KEY", "required": true, "schema": { "type": "string" }, "example": "your api key" }, { "name": "CF-ACCESS-SIGN", "in": "header", "description": "The Base64-encoded signature (see signing messages subsection for details) \n使用HMAC SHA256哈希函数获得哈希值，再使用Base-64编码（请参阅签名）", "required": true, "schema": { "type": "string" }, "example": "signature" }, { "name": "CF-ACCESS-TIMESTAMP", "in": "header", "description": "The UTC timestamp of your request .e.g : 2008-08-08T08:08:08.888Z \n发起请求的时间（UTC），如：2008-08-08T08:08:08.888Z", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/XHostBasicEnergyPayload" } } } } } } } }, "components": { "schemas": { "HostBasicEnergyPayload": { "properties": { "id": { "type": "integer", "format": "int64", "description": "ID" }, "address": { "type": "string", "description": "地址" }, "plan_id": { "type": "integer", "format": "int64", "description": "套餐ID" }, "plan_name_en": { "type": "string", "description": "套餐英文名" }, "plan_name_zh": { "type": "string", "description": "套餐中文名" }, "plan_subscription_sun": { "type": "integer", "format": "int64", "description": "套餐的订阅费" }, "plan_unit_sun": { "type": "integer", "format": "int32", "description": "补充能量单价" }, "quota_mode": { "type": "string", "description": "配额模式: UNLIMITED:不受限制；TRANSFER_QUOTA:依据转账次数进行限制；ENERGY_QUOTA:按照能量次数进行配额限制。详细信息参见波场伴侣文档", "enum": [ "UNLIMITED", "TRANSFER_QUOTA", "ENERGY_QUOTA" ] }, "slot_next_billing_timestamp": { "type": "integer", "format": "int64", "description": "下次订阅费时间" }, "quantity": { "type": "integer", "format": "int32", "description": "每次补充的能量数量" }, "used_quantity": { "type": "integer", "format": "int64", "description": "累计使用能量" }, "quota_count": { "type": "integer", "format": "int32", "description": "总配额次数" }, "used_count": { "type": "integer", "format": "int32", "description": "已使用次数" }, "quota_start_time": { "type": "integer", "format": "int64", "description": "配额开始时间" }, "total_transfer_count": { "type": "integer", "format": "int32", "description": "累计转账次数" }, "total_energy_count": { "type": "integer", "format": "int32", "description": "累计能量次数" }, "total_slot_fee": { "type": "integer", "format": "int64", "description": "累计订阅费" }, "total_energy_fee": { "type": "integer", "format": "int64", "description": "累计补能费" }, "remark": { "type": "string", "description": "备注" }, "is_auto_closable": { "type": "boolean", "description": "是否72小时未使用自动关闭" }, "idle_hours": { "type": "integer", "format": "int32", "description": "闲置自动关闭时间(小时)" }, "bandwidth_guarantee": { "type": "boolean", "description": "是否开始带宽保护" }, "status": { "type": "string", "description": "状态: 1=正常 2=欠费暂停 3=人工暂停", "enum": [ "ACTIVE", "PAUSED", "MANUAL_PAUSED", "API_PAUSED", "UNUSED_PAUSED", "QUOTA_PAUSED", "EXPIRED_PAUSED" ] }, "expired_at": { "type": "integer", "format": "int64", "description": "过期时间" }, "created_at": { "type": "integer", "format": "int64", "description": "创建时间" } } }, "XHostBasicEnergyPayload": { "properties": { "code": { "type": "integer", "format": "int32", "description": "成功返回0，其他均为错误" }, "msg": { "type": "string", "description": "发生错误时候返回的消息" }, "sub_code": { "type": "string" }, "sub_msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/HostBasicEnergyPayload" } } }, "XObject": { "properties": { "code": { "type": "integer", "format": "int32", "description": "成功返回0，其他均为错误" }, "msg": { "type": "string", "description": "发生错误时候返回的消息" }, "sub_code": { "type": "string" }, "sub_msg": { "type": "string" }, "data": { "type": "object" } } } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer" }, "API_KEY": { "type": "apiKey", "name": "CF-ACCESS-KEY", "in": "header" }, "API_SIGN": { "type": "apiKey", "name": "CF-ACCESS-SIGN", "in": "header" }, "API_TIMESTAMP": { "type": "apiKey", "name": "CF-ACCESS-TIMESTAMP", "in": "header" } } } }