V8API 文档

前言导读

本 API 文档旨在为开发者提供清晰、准确且全面的指引，帮助你快速理解和有效地使用我们所提供的 API 服务，您可通过本文档了解产品的 API 的功能特性、调用方法、参数说明以及返回结果的格式，让你能够轻松地将我们的 API 集成到你的项目中，为您的应用增添强大的功能和价值。

开启接口

系统是默认关闭接口功能的，您可通过如下介绍开启并获取 API 密钥。

1. 系统参数-功能参数-通用配置-API 接口-启用
2. 用户管理-API-启用
3. 复制 API 密钥供接口调用

接口鉴权

为确保 API 的安全使用和对资源的合理访问控制，本 API 采用 API 密钥进行鉴权。在进行 API 请求时，需在请求的 Header 中添加 API 密钥。

1. 在获取到 API 密钥后，请妥善保管，不要泄露给未经授权的人员。
2. 在请求的 Header 中添加一个名为 “Authorization” 的字段。
3. 将 API 密钥的值设置为该字段的值，格式通常为 “Bearer 1|xxx “。
4. 当您使用密钥调用 API 接口的时候，会自动绑定关联用户。

接口说明

因返回示例有数据量较大且存在重复性，本文仅对请求参数做出字段介绍，涉及到返回数据字段说明请参阅开发文档的数据文档，您还可以通过访问 nodcloud-erp.apifox.cn 来获取更多信息。

接口规范

为确保接口数据的一致性，采用如下统一的接口返回格式

//成功
{
    "state":"success",
    "info":"1|EsaXFTa3c65IYj2r9BCtt2OUi10t5GQrFi7bT2Tr"
}
//警告
{
    "state":"warning",
    "message":"账号密码错误"
}
//错误
{
    "state":"error",
    "message":"内部错误"
}

文档内容

因API文档内容项较大，请点击下载PDF版。