API Mewayz 附加组件
探索 Mewayz 的 API 集成的强大功能，实现无缝项目和任务管理。轻松扩展和定制。立即尝试！
简介
API 文档生成器是一个功能强大的附加组件，为 Mewayz 平台提供完整的 API 文档。该附加组件可帮助开发人员和技术团队访问详细的 API 信息，包括端点、标头、参数和响应示例。该文档涵盖了平台的 14 个主要模块，使用户能够构建自定义应用程序、集成外部系统或使用 Postman 等工具手动测试 API。
如何启用该模块
要设置 API 附加组件，您可以点击以下链接： 设置附加组件。
如何使用API插件？
生成API文档
购买并安装此附加组件后，转到仪表板侧边栏并搜索 API 文档附加组件。
要访问 API 文档，请从主仪表板导航至 Api 文档部分。该文档的组织者是 14个模块，让您可以轻松找到集成项目所需的特定 API。
本节包括解释如何有效使用 API 的一般介绍。本概述涵盖了适用于所有 API 端点的身份验证要求、通用标头和基本使用指南。
每个模块都包含强大的 API 列表和完整的技术细节。对于每个 API 端点，您将找到 API 名称、确切的端点 URL、身份验证和数据格式所需的标头、输入参数及其数据类型和验证规则、显示预期数据结构的示例成功响应以及包含常见错误代码和消息的示例错误响应。
简介 管理
这份全面的 API 文档是您利用 Mewayz 功能强大功能的门户，让您能够简化工作、提高生产力，并将您的项目提升到新的水平。
此 API 文档是为希望在应用程序中利用 Mewayz 功能的经验丰富的开发人员和新手开发人员提供的资源。这是您可以期待找到的内容。
您可以在下面浏览产品内的完整交互式参考 设置 → API 文档。
端点部分涵盖用于检索数据的 GET、用于创建新数据的 POST、用于更新现有数据的 POST 以及用于删除数据的 DELETE。您可以使用 HTTP 方法（如 GET 检索数据、POST 创建新数据、POST 更新现有数据以及 DELETE 删除数据）。
请求参数用于自定义 API 请求的行为，并在与 API 交互时提供更具体的详细信息。对于 Mewayz，您可能具有以下类型的请求参数：用于在检索信息时对数据进行过滤或排序的查询参数、用于身份验证的请求标头和有关请求的其他元数据，以及包含要创建或更新的 JSON 数据的请求正文。
Mewayz的API通常以JSON格式响应数据。响应通常包括指示请求结果的 HTTP 状态代码，并且实际数据包含在 “数据” 场。
认证管理
身份验证 API 提供基本的登录功能、用于维护会话的令牌刷新功能以及用于安全地最终用户会话的注销程序。
登录端点 POST /api/login 需要标头 “接受”: “应用程序/json” 和参数，包括电子邮件等 “[email protected]” 密码如 **“john****”**。
错误响应返回 422 Unprocessable Content with “成功”：假的， “消息”: “验证 当验证出现错误时。
错误响应返回 400 Unauthorized with “成功”：假的， “消息”: “所提供的” 当凭证无效时。
成功的登录响应返回 200 OK “成功”: true 且授权包含令牌和类型 “承载者” 用于后续 API 调用。
身份验证刷新端点 POST /api/refresh 使用带有承载令牌的授权标头进行会话管理。
成功的刷新响应返回详细的用户信息，包括 200 OK “成功”：true，以及用户详细信息、id、姓名、电子邮件、手机号、类型： “公司”，头像： “网址”, 郎: “恩” 和令牌。
用户管理
- 用于用户管理、角色管理和配置文件的用户 API
操作。
仓库管理
- 用于仓库配置和仓库转移的仓库 API
管理。
产品与服务管理
- 产品和服务部分 API 管理产品类别、税收、
计量单位、产品和库存管理与仓库集成。
采购发票管理
- 用于采购发票列表、创建、详细信息的采购发票 API
更新、删除、发票过帐管理。
采购退货管理
- 用于处理采购退货列表、创建、退货详细信息的 API，
删除、批准、完成处理。
销售提案管理
- 用于提案管理和转换的销售提案 API
流程。
销售发票管理
- 销售发票 API 处理发票列表、创建、更新、删除、
发票过帐管理。
销售发票退货管理
- 用于管理销售发票退货列表、创建、详细信息、删除、
批准并完成。
账户管理
- 帐户部分 API 允许您管理客户、供应商、
- 帐户模块包括用于检索简单信息的快速列表 API
银行账户、科目表、收入、费用、贷方票据、借方票据、供应商付款、客户付款、银行交易、银行转账记录。您可以根据需要执行列出记录、创建新条目、查看详细信息、更新信息和删除记录等操作。
客户和供应商列表、总账户列表以及用于下拉选择和快速参考的收入和费用类别。
项目管理
- 项目部分 API 管理项目、任务、错误、里程碑、
文件以及各种报告及其相关阶段和工作流程。
销售点管理
- POS API 处理销售点操作，包括订单管理
和订单详细信息。
客户关系管理
- CRM 部分 API 涵盖管道管理、引导和交易阶段、
标签、来源以及完整的潜在客户管理和交易管理。您可以管理与潜在客户和交易相关的任务、用户、产品、来源、电子邮件、讨论、文件和通话。
人力资源管理
- HRM API 处理员工管理、组织结构、
出勤跟踪、休假管理、薪资处理和各种人力资源记录，包括奖励、晋升、辞职、终止、警告、投诉、员工调动、假期、活动、文件、公告和致谢。
文档中的每个 API 端点都包含实际示例，您可以直接在开发环境或测试工具中复制和使用这些示例。响应示例显示了成功的操作和常见错误场景，帮助您在应用程序中实施正确的错误处理。
Modules Wise API 列表：
- 认证：
- 登录
- 令牌刷新
- 退出
- 用户：
- 用户： 列表、创建、更新、删除、
- 角色 ： 列表
- 用户日志： 列表
- 员工用户： 列表
- 客户用户： 列表
- 供应商用户： 列表
- 仓库：
个人资料更新、密码更新、重置密码、验证
- 仓库： 列表、创建、详细信息、更新、
- 转乘： 列表、创建请求数据、
- 产品与服务：
删除
创建、删除
- 产品类别： 列表、创建、更新、
- 税费： 列表、创建、更新、删除
- 单位： 列表、创建、更新、删除
- 产品： 列表、创建、详细信息、更新、
- 产品库存： 列表、添加
- 仓库产品： 列表
- 采购发票：
删除
删除
- 发票： 列表、创建、详细信息、更新、
- 购买退货：
删除、发布
- 返回： 列表、创建、详细信息、删除、
- 销售建议：
批准、完成
- 建议： 列表、创建、详细信息、更新、
- 销售发票：
删除、发送、接受、拒绝、转换为发票
- 发票： 列表、创建、详细信息、更新、
- 销售发票退回：
删除、发布
- 返回： 列表、创建、详细信息、删除、
- 帐号：
批准、完成
- 获取客户： 简单的客户名单
- 获取供应商： 简单的供应商列表
- 客户： 列表、创建、更新、删除
- 供应商： 列表、创建、更新、删除
- 总账户： 列表
- 银行账户： 列表、创建、更新、删除
- 收入类别： 列表
- 收入： 列表、创建、更新、删除、
- 费用类别： 列表
- 费用： 列表、创建、更新、删除、
- 账户类型： 列表
- 会计科目表： 列表
- 银行交易： 列表
- 银行转账： 列表
- 供应商付款： 列表
- 客户付款： 列表
- 信用证： 列表
- 借方票据： 列表
- 项目：
批准，发布
批准，发布
- 项目： 列表、创建、详细信息、更新、
- 项目成员： 删除
- 项目客户： 列表、邀请、删除
- 项目里程碑： 列表、创建、更新、
- 项目文件： 创建、删除
- 任务： 任务板、创建、详细信息、更新、
- 任务评论： 创建、删除
- 任务子任务： 创建、更新
- 错误状态： 列表
- 错误： 列表、创建、详细信息、更新、删除
- 错误评论： 创建、删除
- 项目报告： 列表、详细信息
- 任务阶段： 列表、排序、创建、更新、
- 错误阶段： 列表、排序、创建、更新、
- 销售点：
删除
删除
删除
删除
删除
- 订单： 列表、详细信息
- 客户关系管理：
- 管道： 列表、创建、更新、删除
- 领先阶段： 列表、创建、更新、删除
- 交易阶段： 列表、创建、更新、删除
- 标签： 列表、创建、更新、删除
- 资料来源： 列表、创建、更新、删除
- 铅： 列表、创建、详细信息、更新、
- 主导任务： 创建、更新、删除
- 主要用户： 创建、删除
- 主导产品： 创建、删除
- 潜在客户来源： 创建、删除
- 潜在客户电子邮件： 创建
- 引导讨论： 创建
- 线索文件： 创建、删除
- 潜在客户电话： 创建、更新、删除
- 交易： 列表、创建、详细信息、更新、
- 交易任务： 创建、更新、删除
- 交易用户： 创建、删除
- 优惠产品： 创建、删除
- 交易来源： 创建、删除
- 交易邮箱： 创建
- 交易讨论： 创建
- 交易文件： 创建、删除
- 交易客户： 创建、删除
- 交易电话： 创建、更新、删除
- 人力资源管理：
删除、添加标签、转换为交易
删除、添加标签
- 员工： 列表、创建、详细信息、更新、
- 出席人数： 列表、创建、更新、删除
- 休假类型： 列表
- 请假申请： 列表、创建、更新、
- 休假余额： 检查
- 工资单： 列表、详细信息
- 工资单： 生成
- 班次： 列表
- 分支机构： 列表
- 部门： 列表
- 名称： 列表
- 文件类型： 列表
- 假期： 列表
- 奖项： 列表
- 促销活动： 列表
- 辞职： 列表
- 终止： 列表
- 警告： 列表
- 投诉： 列表
- 员工调动： 列表
- 文件： 列表
- 致谢： 列表
- 公告： 列表
- 活动： 列表
删除
删除、更新状态