開発者 · REST API

上に構築する
Mewayz。

CRM、販売、請求書発行、会計、プロジェクト、POS、人事など、ワークスペース全体にわたる 1 つの REST API。 372 のエンドポイント、どこでも JSON、ベアラー トークンで認証。同じ閲覧可能な参照がアプリ内に存在します。 設定 → API ドキュメント

ベース URL · app.mewayz.com/api 認証 · 無記名トークン フォーマット・ JSON エンドポイント · 372

認証

すべてのリクエストはベアラー トークンで認証されます。ダッシュボードで生成します。 設定→APIキー — 一度表示されるので、それをコピーします。トークンは、それを作成したユーザーのロールと権限を継承します。また、ほとんどのリソース エンドポイントでは、プランで一致するモジュールが有効になっている必要があります。

認可ヘッダー
# リクエストごとにトークンを渡します カールhttps://app.mewayz.com/api/leads \ -H 「権限: ベアラー 12|aZ8f3a...d92c」 \ -H 「受け入れる: application/json」

プログラムによる認証をご希望ですか? POST /api/ログイン メールアドレスとパスワードを指定すると、同じ方法で使用できるベアラー トークンが返されます。 POST /api/refresh それを回転させます。

クイックスタート

1 分以内に CRM リードを作成します。 API は、製品内で表示されるのと同じデータに対して機能します。個別の同期レイヤーはありません。

POST /api/lead/create
カールする -X ポスト https://app.mewayz.com/api/lead/create \ -H 「権限: Bearer 12|aZ8f3a...」 \ -H 「コンテンツタイプ: application/json」 \ -H 「受け入れる: application/json」 \ -d '{ "名前": "エイダ ラブレス", "メール": "[email protected]" }'

エラーとステータスコード

従来の HTTP ステータス コードを使用します。エラー本文には人間が判読できる形式のエラー本文が含まれます。 メッセージ 直接浮上することができます。

200OK — リクエストは成功しました
201作成されました — リソースが作成されました
401未承認 — トークンが欠落しているか無効です
422処理不能 — 検証に失敗しました
429リクエストが多すぎます - レート制限に達しました
500サーバーエラー — オンにします ステータス

レート制限

API トラフィックは、すべてのユーザーにとってプラットフォームの高速性を維持するためにレート制限されています。制限を超えると、 HTTP 429 応答 — 後退して再試行してください。の 再試行後 ヘッダーは、いつ再開できるかを示します。

認証とセッション /api/ログイン

ログイン、トークンの更新または取り消し、サインインしているユーザーの取得、プロファイルの編集、スタッフ/クライアント/ベンダーのユーザー リストの読み取りを行います。 (11 エンドポイント)

投稿/api/パスワード変更
ゲット/api/クライアントユーザー
削除/api/アカウントの削除
投稿/api/編集プロファイル
投稿/api/ログイン
投稿/api/ログアウト
投稿/api/リフレッシュ
ゲット/api/スタッフユーザー
投稿/api/アップロード-写真
ゲット/api/ユーザー
ゲット/api/ベンダーユーザー

API keys /api/v1/設定/APIキー

個人のアクセス トークンを一覧表示、作成、取り消します。これは、[設定] → [API キー] で生成したものと同じキーです。 (3 つのエンドポイント)

ゲット/api/v1/設定/APIキー
投稿/api/v1/設定/APIキー
削除/api/v1/settings/api-keys/{id}

CRM — リード、取引、パイプライン /api/リード

リード、取引、パイプライン、ステージ、ラベル、ソース、さらにそれらのタスク、通話、ファイル、メモ、製品に対する完全な CRUD。 (79 エンドポイント)

削除/api/deal-call/delete/{call_id}
投稿/api/deal-call/store
投稿/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/deal-stage/create
削除/api/deal-stage/delete/{id}
投稿/api/deal-stage/update/{id}
ゲット/api/取引ステージ
投稿/api/deal-task/create
削除/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}/products/{product_id}
ゲット/api/取引
投稿/api/ラベル/作成
削除/api/label/delete/{id}
投稿/api/label/update/{id}
ゲット/api/ラベル
削除/api/lead-call/delete/{call_id}
投稿/api/リードコール/ストア
投稿/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/リードステージ/作成
削除/api/リードステージ/削除/{id}
投稿/api/lead-stage/update/{id}
ゲット/api/リードステージ
投稿/api/リードタスク/作成
削除/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/get-request-data
ゲット/api/lead/get-users
投稿/api/リード/ホーム
投稿/api/lead/lead-create-update
投稿/api/リード/リード-削除
投稿/api/リード/リード-詳細
投稿/api/lead/lead-stage-create-update
投稿/api/lead/lead-stage-update
投稿/api/リード/リードステージ
投稿/api/リード/リードボード
投稿/api/lead/パイプライン作成-更新
ゲット/api/リード/パイプライン
ゲット/api/lead/show/{id}
投稿/api/lead/update/{id}
削除/api/lead/{lead_id}/products/{product_id}
ゲット/api/リード
投稿/api/パイプライン/作成
削除/api/pipeline/delete/{id}
投稿/api/pipeline/update/{id}
ゲット/api/パイプライン
投稿/api/ソース/作成
削除/api/source/delete/{id}
投稿/api/source/update/{id}
ゲット/api/ソース

販売 /api/販売/販売注文

機会、見積書、会議、販売注文、倉庫の検索。 (23 エンドポイント)

ゲット/api/sales/RequestData
投稿/api/sales/get-warehouse-products
ゲット/api/販売/ホーム
削除/api/sales/meeting/destroy/{id}
投稿/api/販売/会議/ストア
投稿/api/sales/meeting/update/{id}
ゲット/api/販売/会議
ゲット/api/販売/機会
削除/api/sales/opportunities/delete/{id}
投稿/api/sales/opportunities/update/{id}
投稿/api/販売/機会/ストア
投稿/api/sales/親レコード
ゲット/api/販売/見積もり
削除/api/sales/quotes/destroy/{id}
投稿/api/販売/見積もり/ストア
投稿/api/sales/quotes/update/{id}
ゲット/api/sales/quotes/{id}
削除/api/sales/sales-order/delete/{id}
投稿/api/販売/販売注文/ストア
投稿/api/sales/sales-order/update/{id}
ゲット/api/販売/販売注文
ゲット/api/sales/sales-orders/{id}
ゲット/api/販売/倉庫

営業提案 /api/販売提案

提案の草案、送信、承認/拒否を行い、請求書に変換します。 (9 エンドポイント)

ゲット/api/販売提案
投稿/api/sales-proposal/accept/{proposal_id}
投稿/api/sales-proposal/convert-to-invoice/{proposal_id}
投稿/api/販売提案/作成
削除/api/sales-proposal/delete/{proposal_id}
投稿/api/sales-proposal/reject/{proposal_id}
投稿/api/sales-proposal/sent/{proposal_id}
ゲット/api/sales-proposal/show/{proposal_id}
投稿/api/sales-proposal/update/{proposal_id}

売上請求書 /api/販売請求書

売上請求書のリスト、作成、更新、削除、転記を行います。 (6 つのエンドポイント)

ゲット/api/販売請求書
投稿/api/販売請求書/作成
削除/api/sales-invoice/delete/{invoice_id}
投稿/api/sales-invoice/post/{invoice_id}
ゲット/api/sales-invoice/show/{invoice_id}
投稿/api/sales-invoice/update/{invoice_id}

売上請求書の返却 /api/販売請求書-return

売上請求書の返品を作成、承認、完了します。 (6 つのエンドポイント)

ゲット/api/販売請求書-return
投稿/api/sales-invoice-return/approve/{return_id}
投稿/api/sales-invoice-return/complete/{return_id}
投稿/api/sales-invoice-return/create
削除/api/sales-invoice-return/delete/{return_id}
ゲット/api/sales-invoice-return/show/{return_id}

請求書の購入 /api/購入請求書

購入請求書のリスト、作成、更新、削除、および転記を行います。 (6 つのエンドポイント)

ゲット/api/購入請求書
投稿/api/購入請求書/作成
削除/api/purchase-invoice/delete/{invoice_id}
投稿/api/purchase-invoice/post/{invoice_id}
ゲット/api/purchase-invoice/show/{invoice_id}
投稿/api/purchase-invoice/update/{invoice_id}

購入の返品 /api/購入-返品

購入返品を作成、承認、完了します。 (6 つのエンドポイント)

ゲット/api/購入-返品
投稿/api/purchase-return/approve/{return_id}
投稿/api/purchase-return/complete/{return_id}
投稿/api/purchase-return/create
削除/api/purchase-return/delete/{return_id}
ゲット/api/purchase-return/show/{return_id}

会計 /api/勘定科目表

顧客、ベンダー、銀行口座、勘定科目表、収益、経費、支払い、クレジット/デビットノート、送金。 (37 エンドポイント)

ゲット/api/アカウントの種類
ゲット/api/銀行口座
投稿/api/銀行口座/作成
削除/api/bank-accounts/delete/{id}
投稿/api/bank-accounts/update/{id}
ゲット/api/銀行取引
ゲット/api/銀行振込
ゲット/api/勘定科目表
ゲット/api/クレジットメモ
ゲット/api/顧客支払い
ゲット/api/顧客
投稿/api/顧客/作成
削除/api/customers/delete/{id}
投稿/api/customers/update/{id}
ゲット/api/デビットノート
ゲット/api/経費カテゴリ
ゲット/api/経費
投稿/api/expenses/approve/{id}
投稿/api/経費/作成
削除/api/経費/削除/{id}
投稿/api/expenses/post/{id}
投稿/api/expenses/update/{id}
ゲット/api/get-clients
ゲット/api/get-vendors
ゲット/api/gl-アカウント
ゲット/api/収益カテゴリ
ゲット/api/収益
投稿/api/収益/approve/{id}
投稿/api/収益/作成
削除/api/収益/削除/{id}
投稿/api/収益/post/{id}
投稿/api/revenues/update/{id}
ゲット/api/ベンダー支払い
ゲット/api/ベンダー
投稿/api/ベンダー/作成
削除/api/vendors/delete/{id}
投稿/api/vendors/update/{id}

製品とサービス /api/製品

製品、カテゴリ、税金、単位、在庫。 (20 エンドポイント)

ゲット/api/製品サービス/アイテム
投稿/api/製品ストック/追加
ゲット/api/製品ストック
ゲット/api/製品/カテゴリ
投稿/api/製品/カテゴリ/作成
削除/api/product/category/delete/{id}
投稿/api/product/category/update/{id}
投稿/api/製品/作成
削除/api/product/delete/{id}
ゲット/api/製品/詳細/{id}
投稿/api/product/update/{id}
ゲット/api/製品
ゲット/api/税金
投稿/api/税金/作成
削除/api/tax/delete/{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/transfer/リクエストデータ
ゲット/api/ウェアハウス
投稿/api/ウェアハウス/作成
削除/api/warehouse/delete/{warehouse_id}
ゲット/api/warehouse/product/{warehouse_id}
投稿/api/warehouse/update/{warehouse_id}

プロジェクト、タスク、バグ /api/プロジェクト

プロジェクト、マイルストーン、タスクボード、タスク、サブタスク、バグ、レポート。 (45 エンドポイント)

ゲット/api/バグステータスリスト
ゲット/api/get-プロジェクト
投稿/api/プロジェクト/バグステージ/作成
削除/api/project/bug-stage/delete/{id}
投稿/api/プロジェクト/バグステージ/オーダー
投稿/api/project/bug-stage/update/{id}
ゲット/api/プロジェクト/バグステージ
投稿/api/project/bug/create/{project_id}
ゲット/api/プロジェクト/bug/show/{bug_id}
投稿/api/プロジェクト/bug/{bug_id}/comment/create
削除/api/プロジェクト/バグ/{id}/コメント/削除
ゲット/api/project/bug/{project_id}
削除/api/プロジェクト/クライアント/削除/{id}
投稿/api/プロジェクト/クライアント/招待
ゲット/api/プロジェクト/クライアント
削除/api/プロジェクト/削除/{id}
投稿/api/プロジェクト/ファイル/作成
削除/api/プロジェクト/ファイル/削除/{id}
削除/api/プロジェクト/メンバー/削除/{id}
投稿/api/プロジェクト/マイルストーン/作成
削除/api/プロジェクト/マイルストーン/削除/{id}
投稿/api/プロジェクト/マイルストーン/更新/{id}
ゲット/api/プロジェクト/マイルストーン
ゲット/api/プロジェクト/レポート/{id}
ゲット/api/プロジェクト/レポート
ゲット/api/プロジェクト/show/{id}
投稿/api/プロジェクト/タスクステージ/作成
削除/api/プロジェクト/タスクステージ/削除/{id}
投稿/api/プロジェクト/タスクステージ/オーダー
投稿/api/プロジェクト/タスクステージ/更新/{id}
ゲット/api/プロジェクト/タスクステージ
投稿/api/project/task-subtask/create/{task_id}
投稿/api/project/task-subtask/update/{subtask_id}
削除/api/プロジェクト/タスク/コメント/削除/{comment_id}
ゲット/api/プロジェクト/タスク/ショー/{id}
投稿/api/プロジェクト/タスク/{task_id}/comment/create
投稿/api/プロジェクト/更新/{id}
ゲット/api/プロジェクト/{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/サポートチケット/チケット

チケットと返信、FAQ、ナレッジベースの記事。 (16 エンドポイント)

投稿/api/support-ticket/faq/delete/{faq_id}
投稿/api/support-ticket/faq/update/{faq_id}
ゲット/api/サポートチケット/よくある質問
投稿/api/サポートチケット/faq/store
ゲット/api/サポートチケット/get-request-data
ゲット/api/サポートチケット/ホーム
投稿/api/support-ticket/knowledge/delete/{knowledge_id}
投稿/api/サポートチケット/ナレッジ/ストア
投稿/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/サポートチケット/チケット/ストア
投稿/api/support-ticket/ticket/update/{ticket_id}
ゲット/api/サポートチケット/チケット

タスクリー /api/taskly/プロジェクト

Taskly のプロジェクトと軽量プロジェクト モジュールのタスク。 (18 エンドポイント)

ゲット/api/taskly/home
投稿/api/taskly/プロジェクトアクティビティ
投稿/api/taskly/プロジェクト作成-更新
投稿/api/taskly/プロジェクト削除
投稿/api/taskly/プロジェクトの詳細
削除/api/taskly/プロジェクトファイル削除/{id}
投稿/api/taskly/プロジェクトファイルアップロード
投稿/api/taskly/プロジェクトリスト
投稿/api/taskly/プロジェクトステータス更新
ゲット/api/taskly/プロジェクト
ゲット/api/taskly/projects/{プロジェクト}/tasks
投稿/api/taskly/タスク作成-更新
投稿/api/taskly/タスク削除
投稿/api/taskly/タスクの詳細
投稿/api/taskly/タスクリスト
投稿/api/taskly/タスクステージ更新
投稿/api/taskly/タスクボード
ゲット/api/taskly/users

時間の追跡 /api/追加トラッカー

時間トラッカーを開始および停止します。 (3 つのエンドポイント)

投稿/api/追加トラッカー
投稿/api/ストップトラッカー
投稿/api/トラッカーログイン

ユーザーと役割 /api/ユーザー

ワークスペース ユーザーと読み取りロールを管理します。 (8 つのエンドポイント)

ゲット/api/役割
削除/api/user/delete/{id}
投稿/api/ユーザー/リセットパスワード/{id}
投稿/api/ユーザー/ストア
投稿/api/user/update/{id}
置く/api/user/verify/{id}
ゲット/api/ユーザー
ゲット/api/ユーザー/ログ

人事と給与 /api/従業員

従業員、勤怠、休暇、給与計算に加え、完全な人事記録セット (支店、部門、休日、賞など)。 (44 エンドポイント)

ゲット/api/承認
ゲット/api/お知らせ
投稿/api/出席/作成
削除/api/attendance/delete/{attendance_id}
投稿/api/attendance/update/{attendance_id}
ゲット/api/出席
ゲット/api/賞
ゲット/api/ブランチ
ゲット/api/苦情
ゲット/api/部門
ゲット/api/指定
ゲット/api/ドキュメントタイプ
ゲット/api/従業員の異動
投稿/api/従業員/作成
削除/api/従業員/削除/{id}
ゲット/api/従業員/show/{id}
投稿/api/従業員/更新/{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/ホーム
投稿/api/hrm/leave-request
投稿/api/leave-application/create
削除/api/leave-application/delete/{leaveapplication_id}
投稿/api/leave-application/update-status/{leaveapplication_id}
投稿/api/leave-application/update/{leaveapplication_id}
ゲット/api/leave-アプリケーション
ゲット/api/leave-balances
ゲット/api/leave-types
ゲット/api/給与計算
ゲット/api/payrolls/{payroll_id}
ゲット/api/給与明細/{payroll_entry_id}
ゲット/api/プロモーション
ゲット/api/辞任
ゲット/api/シフト
ゲット/api/終了
ゲット/api/警告

サードパーティ API (v1) /api/v1/顧客

Zapier のようなノーコード ツール (顧客と請求書) 向けに構築された安定したバージョン管理されたスライス。 (7 つのエンドポイント)

ゲット/api/v1/顧客
投稿/api/v1/顧客
ゲット/api/v1/customers/{id}
置く/api/v1/customers/{id}
ゲット/api/v1/請求書
投稿/api/v1/請求書
ゲット/api/v1/invoices/{id}

パブリックエンドポイント /api/パブリック/プラン

認証されていないヘルパー: パブリック プラン カタログと、埋め込み可能なリード獲得ウィジェットとパートナー バッジ。 (4 つのエンドポイント)

ゲット/api/badge/{トークン}
ゲット/api/パブリック/プラン
投稿/api/ウィジェット/リード
ゲット/api/ウィジェット/{トークン}

ホワイトラベルプラットフォーム /api/wl/プラン

請求および Stripe Connect (トークン認証) のためにホワイトラベル インスタンスによって使用されるサーバー間エンドポイント。 (6 つのエンドポイント)

投稿/api/wl/チェックアウト
投稿/api/wl/connect/onboard
ゲット/api/wl/接続/ステータス
ゲット/api/wl/プラン
投稿/api/wl/subscription/{ストライプ_サブスクリプション_id}/キャンセル
投稿/api/wl/webhook-callback

統合エンドポイント /api/microsofttodo

接続された統合のためのヘルパー エンドポイント (Microsoft To Do、Vonage SMS、Facebook 投稿)。 (3 つのエンドポイント)

ゲット/api/facebookpost
ゲット/api/microsofttodo
ゲット/api/vonagesms

より多くのエンドポイント

追加の登録済みエンドポイント。 (エンドポイント 1 つ)

ゲット/api/agents/{agent}/outstanding-commissions