API集成 #

API集成用于码如云向客户方的IT系统提供开放的API调用接口。通过API集成，客户方IT系统可以完成诸如查询实例详情、创建实例和提交表单等操作。

API访问方式 #

所有的API均使用相同的URL前缀：

https://api.mryqr.com/integration/

API集成采用HTTP的基本认证方式，其中用户名和密码可以在"账户设置"页面的"API集成"标签页进行设置。

在上图中，API Key即HTTP基本认证的用户名，API Secret则表示HTTP基本认证的密码。

例如，通过以下curl命令可以获取当前账户下的所有应用列表：

curl --user your_api_key:your_api_secret -X GET https://api.mryqr.com/integration/apps

统一错误返回 #

当调用API发生错误时，系统将返回统一格式的错误消息体：

{
    "error": {
        "code": "SYSTEM_ERROR",
        "message": "系统错误。",
        "userMessage": "系统错误。",
        "status": 500,
        "path": "/integration/apps",
        "timestamp": 1667821993488,
        "traceId": "ce9b35394d6d6607",
        "data": null
    }
}

字段含义：

各API的调用详情请参考"API列表"。