API文档·Mewayz

认证

每个请求都使用不记名令牌进行身份验证。在您的仪表板中生成一个 设置 → API 密钥 — 它显示一次，所以复制它。令牌继承创建它的用户的角色和权限，并且大多数资源端点还需要在您的计划中启用匹配模块。

授权标头

# 在每次请求时传递您的令牌卷曲https://app.mewayz.com/api/leads\ -H “授权：承载 12|aZ8f3a...d92c” \ -H “接受：应用程序/json”

更喜欢以编程方式进行身份验证？ POST /api/登录使用您的电子邮件和密码返回一个不记名令牌，您可以以相同的方式使用，并且 POST /api/刷新旋转它。

快速入门

在不到一分钟的时间内创建 CRM 潜在客户。该 API 的工作原理与您在产品中看到的数据相同 - 没有单独的同步层。

POST /api/lead/create

卷曲 -X 发布 https://app.mewayz.com/api/lead/create \ -H “授权：承载12|aZ8f3a……” \ -H “内容类型：应用程序/json” \ -H “接受：应用程序/json” \ -d '{ “名称”：“艾达·洛夫莱斯”， “电子邮件”：“[email protected]” }'

错误和状态代码

我们使用传统的 HTTP 状态代码。错误体包括人类可读的留言可以直接浮出水面。

200	OK — 请求成功
201	已创建 — 资源已创建
401	未经授权——令牌丢失或无效
第422章	无法处理 — 验证失败
第429章	请求过多 — 您达到了速率限制
500	服务器错误 - 我们将其打开状态

速率限制

API 流量受到速率限制，以保持平台对每个人的快速访问。如果您超出限制，您将收到 HTTP 429 响应 - 退出并重试。的之后重试标题告诉您何时可以恢复。

身份验证和会话 /api/登录

后处理	/api/更改密码
获取	/api/客户端用户
删除	/api/删除帐户
后处理	/api/编辑配置文件
后处理	/api/登录
后处理	/api/注销
后处理	/api/刷新
获取	/api/员工用户
后处理	/api/上传照片
获取	/api/用户
获取	/api/供应商用户

API 密钥 /api/v1/settings/api-keys

列出、创建和撤销您的个人访问令牌 - 与您在“设置”→“API 密钥”下生成的密钥相同。（3个端点）

获取	/api/v1/settings/api-keys
后处理	/api/v1/settings/api-keys
删除	/api/v1/settings/api-keys/{id}

CRM — 销售线索、交易和渠道 /api/线索

对潜在客户、交易、管道、阶段、标签和来源及其任务、通话、文件、注释和产品进行全面的 CRUD。（79 个端点）

删除	/api/deal-call/delete/{call_id}
后处理	/api/交易调用/商店
后处理	/api/deal-call/update/{call_id}
后处理	/api/deal-client/store/{deal_id}
删除	/api/deal-client/{deal_id}/delete/{client_id}
后处理	/api/deal-discussion/store/{deal_id}
后处理	/api/deal-email/store/{deal_id}
后处理	/api/deal-file/store/{deal_id}
删除	/api/deal-file/{deal_id}/delete/{file_id}
后处理	/api/deal-source/store/{deal_id}
删除	/api/deal-source/{deal_id}/delete/{source_id}
后处理	/api/交易阶段/创建
删除	/api/deal-stage/delete/{id}
后处理	/api/deal-stage/update/{id}
获取	/api/交易阶段
后处理	/api/交易任务/创建
删除	/api/deal-task/delete/{id}
后处理	/api/deal-task/update/{id}
后处理	/api/deal-user/store/{deal_id}
删除	/api/deal-user/{deal_id}/delete/{user_id}
后处理	/api/deal/add-label/{id}
后处理	/api/deal/assign-products/{deal_id}
后处理	/api/交易/创建
删除	/api/deal/delete/{id}
获取	/api/deal/show/{id}
后处理	/api/deal/update/{id}
删除	/api/deal/{deal_id}/产品/{product_id}
获取	/api/交易
后处理	/api/标签/创建
删除	/api/标签/删除/{id}
后处理	/api/标签/更新/{id}
获取	/api/标签
删除	/api/lead-call/delete/{call_id}
后处理	/api/lead-call/store
后处理	/api/lead-call/update/{call_id}
后处理	/api/lead-discussion/store/{lead_id}
后处理	/api/lead-email/store/{lead_id}
后处理	/api/lead-file/store/{lead_id}
删除	/api/lead-file/{lead_id}/delete/{file_id}
后处理	/api/lead-source/store/{lead_id}
删除	/api/lead-source/{lead_id}/delete/{source_id}
后处理	/api/lead-stage/create
删除	/api/lead-stage/delete/{id}
后处理	/api/lead-stage/update/{id}
获取	/api/引导阶段
后处理	/api/lead-task/create
删除	/api/lead-task/delete/{id}
后处理	/api/lead-task/update/{id}
后处理	/api/lead-user/store/{lead_id}
删除	/api/lead-user/{lead_id}/delete/{user_id}
后处理	/api/lead/add-label/{id}
后处理	/api/lead/assign-products/{lead_id}
后处理	/api/lead/convert-to-deal/{id}
后处理	/api/引导/创建
删除	/api/lead/delete/{id}
获取	/api/lead/获取请求数据
获取	/api/lead/获取用户
后处理	/api/lead/home
后处理	/api/lead/lead-create-update
后处理	/api/lead/lead-删除
后处理	/api/lead/lead-详细信息
后处理	/api/lead/lead-stage-create-update
后处理	/api/lead/lead-stage-update
后处理	/api/lead/lead-stages
后处理	/api/lead/排行榜
后处理	/api/lead/pipeline-create-update
获取	/api/lead/管道
获取	/api/lead/show/{id}
后处理	/api/lead/update/{id}
删除	/api/lead/{lead_id}/products/{product_id}
获取	/api/线索
后处理	/api/管道/创建
删除	/api/管道/删除/{id}
后处理	/api/管道/更新/{id}
获取	/api/管道
后处理	/api/源/创建
删除	/api/源/删除/{id}
后处理	/api/源/更新/{id}
获取	/api/来源

销售 /api/销售/销售订单

机会、报价、会议、销售订单和仓库查找。（23 个端点）

获取	/api/销售/RequestData
后处理	/api/sales/获取仓库产品
获取	/api/销售/主页
删除	/api/sales/会议/销毁/{id}
后处理	/api/销售/会议/商店
后处理	/api/sales/会议/更新/{id}
获取	/api/销售/会议
获取	/api/销售/机会
删除	/api/sales/opportunities/delete/{id}
后处理	/api/sales/opportunities/update/{id}
后处理	/api/销售/机会/商店
后处理	/api/销售/父记录
获取	/api/销售/报价
删除	/api/sales/quotes/destroy/{id}
后处理	/api/销售/报价/商店
后处理	/api/sales/quotes/update/{id}
获取	/api/销售/报价/{id}
删除	/api/sales/销售订单/删除/{id}
后处理	/api/销售/销售订单/商店
后处理	/api/sales/销售订单/更新/{id}
获取	/api/销售/销售订单
获取	/api/sales/销售订单/{id}
获取	/api/销售/仓库

销售建议 /api/销售提案

起草、发送、接受/拒绝提案并将其转换为发票。（9 个端点）

获取	/api/销售提案
后处理	/api/销售提案/接受/{proposal_id}
后处理	/api/销售提案/转换为发票/{proposal_id}
后处理	/api/销售提案/创建
删除	/api/销售提案/删除/{proposal_id}
后处理	/api/销售提案/拒绝/{proposal_id}
后处理	/api/销售提案/已发送/{proposal_id}
获取	/api/sales-proposal/show/{proposal_id}
后处理	/api/销售提案/更新/{proposal_id}

销售发票 /api/销售发票

列出、创建、更新、删除和过帐销售发票。（6 个端点）

获取	/api/销售发票
后处理	/api/销售发票/创建
删除	/api/销售发票/删除/{invoice_id}
后处理	/api/销售发票/post/{invoice_id}
获取	/api/销售发票/show/{invoice_id}
后处理	/api/销售发票/更新/{invoice_id}

销售发票退回 /api/销售发票退货

创建、批准并完成销售发票退货。（6 个端点）

获取	/api/销售发票退货
后处理	/api/销售发票-return/approve/{return_id}
后处理	/api/销售发票-return/complete/{return_id}
后处理	/api/销售发票返回/创建
删除	/api/销售发票返回/删除/{return_id}
获取	/api/sales-invoice-return/show/{return_id}

采购发票 /api/采购发票

列出、创建、更新、删除和过帐采购发票。（6 个端点）

获取	/api/采购发票
后处理	/api/采购发票/创建
删除	/api/采购发票/删除/{invoice_id}
后处理	/api/采购发票/post/{invoice_id}
获取	/api/采购发票/show/{invoice_id}
后处理	/api/采购发票/更新/{invoice_id}

购买退货 /api/购买退货

创建、批准并完成采购退货。（6 个端点）

获取	/api/购买退货
后处理	/api/购买退货/批准/{return_id}
后处理	/api/购买退货/完成/{return_id}
后处理	/api/购买退货/创建
删除	/api/购买退货/删除/{return_id}
获取	/api/purchase-return/show/{return_id}

会计 /api/科目表

客户、供应商、银行账户、会计科目表、收入、支出、付款、贷项/借项票据和转账。（37 个端点）

获取	/api/账户类型
获取	/api/银行账户
后处理	/api/银行账户/创建
删除	/api/银行账户/删除/{id}
后处理	/api/银行账户/更新/{id}
获取	/api/银行交易
获取	/api/银行转账
获取	/api/科目表
获取	/api/贷项票据
获取	/api/客户付款
获取	/api/客户
后处理	/api/客户/创建
删除	/api/客户/删除/{id}
后处理	/api/客户/更新/{id}
获取	/api/借方票据
获取	/api/费用类别
获取	/api/费用
后处理	/api/费用/批准/{id}
后处理	/api/费用/创建
删除	/api/费用/删除/{id}
后处理	/api/费用/post/{id}
后处理	/api/费用/更新/{id}
获取	/api/获取客户端
获取	/api/获取供应商
获取	/api/gl-账户
获取	/api/收入类别
获取	/api/收入
后处理	/api/revenues/approve/{id}
后处理	/api/收入/创建
删除	/api/收入/删除/{id}
后处理	/api/revenues/post/{id}
后处理	/api/收入/更新/{id}
获取	/api/供应商付款
获取	/api/供应商
后处理	/api/供应商/创建
删除	/api/供应商/删除/{id}
后处理	/api/vendors/update/{id}

产品与服务 /api/产品

产品、类别、税收、单位和库存。（20 个端点）

获取	/api/产品服务/项目
后处理	/api/产品库存/添加
获取	/api/产品库存
获取	/api/产品/类别
后处理	/api/产品/类别/创建
删除	/api/产品/类别/删除/{id}
后处理	/api/产品/类别/更新/{id}
后处理	/api/产品/创建
删除	/api/产品/删除/{id}
获取	/api/产品/详细信息/{id}
后处理	/api/产品/更新/{id}
获取	/api/产品
获取	/api/税
后处理	/api/税/创建
删除	/api/tax/删除/{id}
后处理	/api/tax/update/{id}
后处理	/api/单元/创建
删除	/api/unit/delete/{id}
后处理	/api/unit/update/{id}
获取	/api/单位

仓库及库存 /api/仓库

仓库和库存转移。（9 个端点）

获取	/api/传输
后处理	/api/传输/创建
删除	/api/transfer/delete/{transfer_id}
获取	/api/传输/请求数据
获取	/api/仓库
后处理	/api/仓库/创建
删除	/api/warehouse/delete/{warehouse_id}
获取	/api/warehouse/product/{warehouse_id}
后处理	/api/warehouse/update/{warehouse_id}

项目、任务和错误 /api/项目

项目、里程碑、任务板、任务、子任务、错误和报告。（45 个端点）

获取	/api/错误状态列表
获取	/api/获取项目
后处理	/api/project/bug-stage/create
删除	/api/project/bug-stage/delete/{id}
后处理	/api/project/bug-stage/order
后处理	/api/project/bug-stage/update/{id}
获取	/api/项目/错误阶段
后处理	/api/project/bug/create/{project_id}
获取	/api/project/bug/show/{bug_id}
后处理	/api/project/bug/{bug_id}/comment/create
删除	/api/project/bug/{id}/comment/delete
获取	/api/project/bug/{project_id}
删除	/api/project/client/delete/{id}
后处理	/api/项目/客户端/邀请
获取	/api/项目/客户端
删除	/api/项目/删除/{id}
后处理	/api/项目/文件/创建
删除	/api/项目/文件/删除/{id}
删除	/api/project/member/delete/{id}
后处理	/api/项目/里程碑/创建
删除	/api/项目/里程碑/删除/{id}
后处理	/api/项目/里程碑/更新/{id}
获取	/api/项目/里程碑
获取	/api/项目/报告/{id}
获取	/api/项目/报告
获取	/api/project/show/{id}
后处理	/api/项目/任务阶段/创建
删除	/api/project/task-stage/delete/{id}
后处理	/api/项目/任务阶段/订单
后处理	/api/project/task-stage/update/{id}
获取	/api/项目/任务阶段
后处理	/api/project/task-subtask/create/{task_id}
后处理	/api/project/task-subtask/update/{subtask_id}
删除	/api/project/task/comment/delete/{comment_id}
获取	/api/project/task/show/{id}
后处理	/api/project/task/{task_id}/comment/create
后处理	/api/项目/更新/{id}
获取	/api/project/{id}/任务板
后处理	/api/项目/{id}/任务/创建
后处理	/api/project/{id}/task/update/{task_id}
删除	/api/project/{project_id}/bug/delete/{bug_id}
后处理	/api/project/{project_id}/bug/update/{bug_id}
删除	/api/project/{project_id}/task/delete/{task_id}
获取	/api/项目
后处理	/api/项目/创建

销售点 /api/pos

POS 订单和订单详细信息。（2 个端点）

获取	/api/pos
获取	/api/pos/show/{id}

支持台 /api/支持票证/票证

票证和回复、常见问题解答和知识库文章。（16 个端点）

后处理	/api/support-ticket/faq/delete/{faq_id}
后处理	/api/support-ticket/faq/update/{faq_id}
获取	/api/support-ticket/常见问题解答
后处理	/api/support-ticket/faqs/store
获取	/api/support-ticket/获取请求数据
获取	/api/支持票/home
后处理	/api/support-ticket/knowledge/delete/{knowledge_id}
后处理	/api/support-ticket/知识/商店
后处理	/api/support-ticket/knowledge/update/{knowledge_id}
获取	/api/支持票/知识
后处理	/api/support-ticket/ticket/add-reply/{ticket_id}
后处理	/api/support-ticket/ticket/delete/{ticket_id}
后处理	/api/support-ticket/ticket/note/store/{ticket_id}
后处理	/api/support-ticket/ticket/store
后处理	/api/support-ticket/ticket/update/{ticket_id}
获取	/api/支持票证/票证

任务性的 /api/taskly/项目

轻量级项目模块的任务性项目和任务。（18 个端点）

获取	/api/taskly/home
后处理	/api/taskly/项目活动
后处理	/api/taskly/项目创建更新
后处理	/api/taskly/项目删除
后处理	/api/taskly/项目详细信息
删除	/api/taskly/project-file-delete/{id}
后处理	/api/taskly/项目文件上传
后处理	/api/taskly/项目列表
后处理	/api/taskly/项目状态更新
获取	/api/taskly/项目
获取	/api/taskly/projects/{project}/tasks
后处理	/api/taskly/任务创建更新
后处理	/api/taskly/任务删除
后处理	/api/taskly/任务详细信息
后处理	/api/taskly/任务列表
后处理	/api/taskly/任务阶段更新
后处理	/api/taskly/任务板
获取	/api/taskly/用户

时间追踪 /api/添加跟踪器

启动和停止时间跟踪器。（3个端点）

后处理	/api/添加跟踪器
后处理	/api/停止跟踪器
后处理	/api/tracker-登录

用户和角色 /api/用户

管理工作区用户并读取角色。（8 个端点）

获取	/api/角色
删除	/api/用户/删除/{id}
后处理	/api/用户/重置密码/{id}
后处理	/api/用户/商店
后处理	/api/用户/更新/{id}
放置	/api/用户/验证/{id}
获取	/api/用户
获取	/api/用户/日志

人力资源和薪资 /api/员工

员工、出勤、休假、工资单以及完整的人力资源记录集（分支机构、部门、假期、奖励等）。（44 个端点）

获取	/api/致谢
获取	/api/公告
后处理	/api/考勤/创建
删除	/api/考勤/删除/{attendance_id}
后处理	/api/考勤/更新/{attendance_id}
获取	/api/考勤
获取	/api/奖项
获取	/api/分支
获取	/api/投诉
获取	/api/部门
获取	/api/名称
获取	/api/文档类型
获取	/api/员工调动
后处理	/api/员工/创建
删除	/api/员工/删除/{id}
获取	/api/employee/show/{id}
后处理	/api/employee/update/{id}
获取	/api/员工
获取	/api/事件
获取	/api/假期
获取	/api/hrm-文档
后处理	/api/hrm/出勤历史记录
后处理	/api/hrm/上下班打卡
后处理	/api/hrm/事件
获取	/api/hrm/get-leaves
获取	/api/hrm/get-leaves-types
获取	/api/hrm/假期列表
获取	/api/hrm/home
后处理	/api/hrm/请假请求
后处理	/api/离开应用程序/创建
删除	/api/leave-application/delete/{leaveapplication_id}
后处理	/api/leave-application/update-status/{leaveapplication_id}
后处理	/api/leave-application/update/{leaveapplication_id}
获取	/api/离开应用程序
获取	/api/休假余额
获取	/api/休假类型
获取	/api/工资单
获取	/api/工资单/{payroll_id}
获取	/api/payslip/{payroll_entry_id}
获取	/api/促销
获取	/api/辞职
获取	/api/班次
获取	/api/终止
获取	/api/警告

第三方 API (v1) /api/v1/客户

为 Zapier 等无代码工具（客户和发票）构建的稳定的版本化切片。（7 个端点）

获取	/api/v1/客户
后处理	/api/v1/客户
获取	/api/v1/客户/{id}
放置	/api/v1/客户/{id}
获取	/api/v1/发票
后处理	/api/v1/发票
获取	/api/v1/发票/{id}

公共端点 /api/public/计划

未经身份验证的助手：公共计划目录和嵌入式潜在客户捕获小部件和合作伙伴徽章。（4 个端点）

获取	/api/徽章/{令牌}
获取	/api/public/计划
后处理	/api/小部件/引导
获取	/api/widget/{令牌}

白标平台 /api/wl/计划

白标签实例用于计费和 Stripe Connect（令牌验证）的服务器到服务器端点。（6 个端点）

后处理	/api/wl/结账
后处理	/api/wl/connect/onboard
获取	/api/wl/连接/状态
获取	/api/wl/计划
后处理	/api/wl/subscription/{stripe_subscription_id}/取消
后处理	/api/wl/webhook 回调

集成端点 /api/microsofttodo

连接集成的帮助端点（Microsoft To Do、Vonage SMS、Facebook 帖子）。（3个端点）

获取	/api/facebookpost
获取	/api/microsofttodo
获取	/api/vonagesms

建立在
Mewayz。

认证

快速入门

错误和状态代码

速率限制

身份验证和会话 /api/登录

API 密钥 /api/v1/settings/api-keys

CRM — 销售线索、交易和渠道 /api/线索

销售 /api/销售/销售订单

销售建议 /api/销售提案

销售发票 /api/销售发票

销售发票退回 /api/销售发票退货

采购发票 /api/采购发票

购买退货 /api/购买退货

会计 /api/科目表

产品与服务 /api/产品

仓库及库存 /api/仓库

项目、任务和错误 /api/项目

销售点 /api/pos

支持台 /api/支持票证/票证

任务性的 /api/taskly/项目

时间追踪 /api/添加跟踪器

用户和角色 /api/用户

人力资源和薪资 /api/员工

第三方 API (v1) /api/v1/客户

公共端点 /api/public/计划

白标平台 /api/wl/计划

集成端点 /api/microsofttodo

更多端点

建立在Mewayz。

认证

快速入门

错误和状态代码

速率限制

身份验证和会话 /api/登录

API 密钥 /api/v1/settings/api-keys

CRM — 销售线索、交易和渠道 /api/线索

销售 /api/销售/销售订单

销售建议 /api/销售提案

销售发票 /api/销售发票

销售发票退回 /api/销售发票退货

采购发票 /api/采购发票

购买退货 /api/购买退货

会计 /api/科目表

产品与服务 /api/产品

仓库及库存 /api/仓库

项目、任务和错误 /api/项目

销售点 /api/pos

支持台 /api/支持票证/票证

任务性的 /api/taskly/项目

时间追踪 /api/添加跟踪器

用户和角色 /api/用户

人力资源和薪资 /api/员工

第三方 API (v1) /api/v1/客户

公共端点 /api/public/计划

白标平台 /api/wl/计划

集成端点 /api/microsofttodo

更多端点

建立在
Mewayz。