מפתחים · REST API

לבנות על
Mewayz.

REST API אחד בכל סביבת העבודה שלך - CRM, מכירות, חשבוניות, הנהלת חשבונות, פרויקטים, POS, HR ועוד. 372 נקודות קצה, JSON בכל מקום, מאומת עם אסימון נושא. אותה הפניה ניתנת לעיון נמצאת תחת האפליקציה הגדרות ← API Docs.

כתובת אתר בסיס · app.mewayz.com/api אישור · אסימון נושא פורמט · JSON נקודות קצה · 372

אימות

כל בקשה מאומתת עם אסימון נושא. צור אחד בלוח המחוונים שלך מתחת הגדרות ← מפתחות API - הוא מוצג פעם אחת, אז העתק אותו. אסימון יורש את התפקידים וההרשאות של המשתמש שיצר אותו, ורוב נקודות הקצה של המשאבים גם דורשות את מודול ההתאמה להיות זמין בתוכנית שלך.

כותרת הרשאה
# העבר את האסימון שלך בכל בקשה תלתל https://app.mewayz.com/api/leads \ -ח "הרשאה: Bearer 12|aZ8f3a...d92c" \ -ח "קבל: application/json"

מעדיף לאמת באופן תוכניתי? POST /api/login עם האימייל והסיסמה שלך מחזיר אסימון נושא שאתה יכול להשתמש באותו אופן, ו POST /api/refresh מסובב אותו.

התחלה מהירה

צור לידת CRM תוך פחות מדקה. ה-API פועל מול אותם נתונים שאתה רואה במוצר - אין שכבת סנכרון נפרדת.

POST /api/lead/create
תלתל -X POST https://app.mewayz.com/api/lead/create \ -ח "הרשאה: נושאת 12|aZ8f3a..." \ -ח "סוג תוכן: application/json" \ -ח "קבל: application/json" \ -ד '{ "name": "עדה לאבלייס", "email": "[email protected]" }'

שגיאות וקודי מצב

אנו משתמשים בקודי מצב HTTP קונבנציונליים. גופי שגיאה כוללים קריאת אדם הודעה אתה יכול לשטח ישירות.

200אישור - הבקשה הצליחה
201נוצר - משאב נוצר
401לא מורשה - אסימון חסר או לא חוקי
422לא ניתן לעיבוד - האימות נכשל
429יותר מדי בקשות - הגעת למגבלת תעריף
500שגיאת שרת - נפעיל אותה סטטוס

מגבלות תעריפים

תעבורת API מוגבלת בקצב כדי לשמור על הפלטפורמה מהירה לכולם. אם תחרוג מהמגבלה תקבל HTTP 429 תגובה - חזור ונסה שוב. ה נסה שוב-אחרי header אומר לך מתי אתה יכול להמשיך.

אימות והפעלה /api/login

התחבר, רענן או בטל את האסימון שלך, אחזר את המשתמש המחובר, ערוך את הפרופיל וקרא את רשימות המשתמשים של צוות/לקוח/ספק. (11 נקודות קצה)

פוסט/api/change-password
קבל/api/client-user
מחק/api/delete-account
פוסט/api/edit-profile
פוסט/api/login
פוסט/api/logout
פוסט/api/refresh
קבל/api/staff-user
פוסט/api/upload-photos
קבל/api/user
קבל/api/vendor-user

מפתחות 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/leads

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/deal-stages
פוסט/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/deal/create
מחק/api/deal/delete/{id}
קבל/api/deal/show/{id}
פוסט/api/deal/update/{id}
מחק/api/deal/{deal_id}/products/{product_id}
קבל/api/deals
פוסט/api/label/create
מחק/api/label/delete/{id}
פוסט/api/label/update/{id}
קבל/api/labels
מחק/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/lead-stages
פוסט/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/lead/create
מחק/api/lead/delete/{id}
קבל/api/lead/get-request-data
קבל/api/lead/get-users
פוסט/api/lead/home
פוסט/api/lead/lead-create-update
פוסט/api/lead/lead-delete
פוסט/api/lead/lead-details
פוסט/api/lead/lead-stage-create-update
פוסט/api/lead/lead-stage-update
פוסט/api/lead/lead-stages
פוסט/api/lead/leadboard
פוסט/api/lead/pipeline-create-update
קבל/api/lead/pipelines
קבל/api/lead/show/{id}
פוסט/api/lead/update/{id}
מחק/api/lead/{lead_id}/products/{product_id}
קבל/api/leads
פוסט/api/pipeline/create
מחק/api/pipeline/delete/{id}
פוסט/api/pipeline/update/{id}
קבל/api/pipelines
פוסט/api/source/create
מחק/api/source/delete/{id}
פוסט/api/source/update/{id}
קבל/api/sources

מכירות /api/sales/sales-orders

הזדמנויות, הצעות מחיר, פגישות, הזמנות מכירה וחיפושי מחסנים. (23 נקודות קצה)

קבל/api/sales/RequestData
פוסט/api/sales/get-warehouse-products
קבל/api/sales/home
מחק/api/sales/meeting/destroy/{id}
פוסט/api/sales/meeting/store
פוסט/api/sales/meeting/update/{id}
קבל/api/מכירות/פגישות
קבל/api/sales/opportunities
מחק/api/sales/opportunities/delete/{id}
פוסט/api/sales/opportunities/update/{id}
פוסט/api/sales/opportunity/store
פוסט/api/sales/parent-records
קבל/api/sales/quotes
מחק/api/sales/quotes/destroy/{id}
פוסט/api/sales/quotes/store
פוסט/api/sales/quotes/update/{id}
קבל/api/sales/quotes/{id}
מחק/api/sales/sales-order/delete/{id}
פוסט/api/sales/sales-order/store
פוסט/api/sales/sales-order/update/{id}
קבל/api/sales/sales-orders
קבל/api/sales/sales-orders/{id}
קבל/api/מכירות/מחסנים

הצעות מכירה /api/sales-proposal

נסח, שלח, קבל/דחה הצעות והמר אותן לחשבוניות. (9 נקודות קצה)

קבל/api/sales-proposal
פוסט/api/sales-proposal/accept/{proposal_id}
פוסט/api/sales-proposal/convert-to-invoice/{proposal_id}
פוסט/api/sales-proposal/create
מחק/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 endpoints)

קבל/api/חשבונית-מכירות
פוסט/api/sales-voice/create
מחק/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/sales-voice-return

צור, אישור והשלם החזרות חשבוניות מכירה. (6 endpoints)

קבל/api/sales-voice-return
פוסט/api/sales-invoice-return/approve/{return_id}
פוסט/api/sales-invoice-return/complete/{return_id}
פוסט/api/sales-voice-return/create
מחק/api/sales-invoice-return/delete/{return_id}
קבל/api/sales-invoice-return/show/{return_id}

חשבוניות רכישה /api/רכישה-חשבונית

רשום, צור, עדכן, מחק ופרסם חשבוניות רכישה. (6 endpoints)

קבל/api/רכישה-חשבונית
פוסט/api/purchase-invoice/create
מחק/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/purchase-return

צור, אשר והשלם החזרות רכישה. (6 endpoints)

קבל/api/purchase-return
פוסט/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/chart-of-accounts

לקוחות, ספקים, חשבונות בנק, טבלת חשבונות, הכנסות, הוצאות, תשלומים, תעודות אשראי/חיוב והעברות. (37 נקודות קצה)

קבל/api/account-types
קבל/api/בנק-חשבונות
פוסט/api/bank-accounts/create
מחק/api/bank-accounts/delete/{id}
פוסט/api/bank-accounts/update/{id}
קבל/api/בנק-עסקאות
קבל/api/העברות בנקאיות
קבל/api/chart-of-accounts
קבל/api/הערות אשראי
קבל/api/customer-payments
קבל/api/customers
פוסט/api/customers/create
מחק/api/customers/delete/{id}
פוסט/api/customers/update/{id}
קבל/api/debit-notes
קבל/api/expense-categories
קבל/api/הוצאות
פוסט/api/expenses/approve/{id}
פוסט/api/expenses/create
מחק/api/expenses/delete/{id}
פוסט/api/expenses/post/{id}
פוסט/api/expenses/update/{id}
קבל/api/get-clients
קבל/api/get-vendors
קבל/api/gl-accounts
קבל/api/revenue-categories
קבל/api/הכנסות
פוסט/api/revenues/approve/{id}
פוסט/api/revenues/create
מחק/api/revenues/delete/{id}
פוסט/api/revenues/post/{id}
פוסט/api/revenues/update/{id}
קבל/api/vendor-payments
קבל/api/vendors
פוסט/api/vendors/create
מחק/api/vendors/delete/{id}
פוסט/api/vendors/update/{id}

מוצרים ושירותים /api/products

מוצרים, קטגוריות, מיסים, יחידות ומלאי. (20 נקודות קצה)

קבל/api/product-service/items
פוסט/api/product-stock/add
קבל/api/product-stocks
קבל/api/product/category
פוסט/api/product/category/create
מחק/api/product/category/delete/{id}
פוסט/api/product/category/update/{id}
פוסט/api/product/create
מחק/api/product/delete/{id}
קבל/api/product/detail/{id}
פוסט/api/product/update/{id}
קבל/api/products
קבל/api/tax
פוסט/api/tax/create
מחק/api/tax/delete/{id}
פוסט/api/tax/update/{id}
פוסט/api/unit/create
מחק/api/unit/delete/{id}
פוסט/api/unit/update/{id}
קבל/api/units

מחסן ומלאי /api/מחסן

מחסנים והעברת מלאי. (9 נקודות קצה)

קבל/api/transfer
פוסט/api/transfer/create
מחק/api/transfer/delete/{transfer_id}
קבל/api/transfer/request-data
קבל/api/מחסן
פוסט/api/warehouse/create
מחק/api/warehouse/delete/{warehouse_id}
קבל/api/warehouse/product/{warehouse_id}
פוסט/api/warehouse/update/{warehouse_id}

פרויקטים, משימות ובאגים /api/projects

פרויקטים, אבני דרך, לוחות משימות, משימות, משימות משנה, באגים ודוחות. (45 נקודות קצה)

קבל/api/bug-status-list
קבל/api/get-projects
פוסט/api/project/bug-stage/create
מחק/api/project/bug-stage/delete/{id}
פוסט/api/project/bug-stage/order
פוסט/api/project/bug-stage/update/{id}
קבל/api/project/bug-stages
פוסט/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/project/client/invite
קבל/api/project/clients
מחק/api/project/delete/{id}
פוסט/api/project/file/create
מחק/api/project/file/delete/{id}
מחק/api/project/member/delete/{id}
פוסט/api/project/milestone/create
מחק/api/project/milestone/delete/{id}
פוסט/api/project/milestone/update/{id}
קבל/api/project/אבני דרך
קבל/api/project/report/{id}
קבל/api/project/reports
קבל/api/project/show/{id}
פוסט/api/project/task-stage/create
מחק/api/project/task-stage/delete/{id}
פוסט/api/project/task-stage/order
פוסט/api/project/task-stage/update/{id}
קבל/api/project/task-stages
פוסט/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/project/update/{id}
קבל/api/project/{id}/task-board
פוסט/api/project/{id}/task/create
פוסט/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/projects
פוסט/api/projects/create

נקודת מכירה /api/pos

הזמנות קופה ופירוט הזמנה. (2 נקודות קצה)

קבל/api/pos
קבל/api/pos/show/{id}

שולחן תמיכה /api/support-ticket/tickets

כרטיסים ותשובות, שאלות נפוצות ומאמרים מבוססי ידע. (16 נקודות קצה)

פוסט/api/support-ticket/faq/delete/{faq_id}
פוסט/api/support-ticket/faq/update/{faq_id}
קבל/api/support-ticket/faqs
פוסט/api/support-ticket/faqs/store
קבל/api/support-ticket/get-request-data
קבל/api/support-ticket/home
פוסט/api/support-ticket/knowledge/delete/{knowledge_id}
פוסט/api/support-ticket/knowledge/store
פוסט/api/support-ticket/knowledge/update/{knowledge_id}
קבל/api/support-ticket/knowledges
פוסט/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/support-ticket/tickets

משימות /api/taskly/projects

פרויקטים ומשימות עבור מודול פרויקט קל משקל. (18 נקודות קצה)

קבל/api/taskly/home
פוסט/api/taskly/project-activity
פוסט/api/taskly/project-create-update
פוסט/api/taskly/project-delete
פוסט/api/taskly/project-details
מחק/api/taskly/project-file-delete/{id}
פוסט/api/taskly/project-file-upload
פוסט/api/taskly/project-list
פוסט/api/taskly/project-status-update
קבל/api/taskly/projects
קבל/api/taskly/projects/{project}/tasks
פוסט/api/taskly/task-create-update
פוסט/api/taskly/task-delete
פוסט/api/taskly/task-details
פוסט/api/taskly/task-list
פוסט/api/taskly/task-stage-update
פוסט/api/taskly/taskboard
קבל/api/taskly/users

מעקב אחר זמן /api/add-tracker

התחל ועצירה של עוקבי זמן. (3 נקודות קצה)

פוסט/api/add-tracker
פוסט/api/stop-tracker
פוסט/api/tracker-login

משתמשים ותפקידים /api/משתמשים

ניהול משתמשי סביבת עבודה וקריאת תפקידים. (8 נקודות קצה)

קבל/api/roles
מחק/api/user/delete/{id}
פוסט/api/user/reset-password/{id}
פוסט/api/user/store
פוסט/api/user/update/{id}
PUT/api/user/verify/{id}
קבל/api/משתמשים
קבל/api/users/log

משאבי אנוש ושכר /api/עובדים

עובדים, נוכחות, חופשות, שכר, בתוספת שיאי משאבי אנוש מלאים (סניפים, מחלקות, חגים, פרסים ועוד). (44 נקודות קצה)

קבל/api/acnowledments
קבל/api/announcements
פוסט/api/attendance/create
מחק/api/attendance/delete/{attendance_id}
פוסט/api/attendance/update/{attendance_id}
קבל/api/נוכחות
קבל/api/awards
קבל/api/branches
קבל/api/complaints
קבל/api/departments
קבל/api/signations
קבל/api/document-types
קבל/api/העברות עובדים
פוסט/api/employee/create
מחק/api/employee/delete/{id}
קבל/api/employee/show/{id}
פוסט/api/employee/update/{id}
קבל/api/עובדים
קבל/api/events
קבל/api/חגים
קבל/api/hrm-documents
פוסט/api/hrm/attendence-history
פוסט/api/hrm/clock-in-out
פוסט/api/hrm/events
קבל/api/hrm/get-leaves
קבל/api/hrm/get-leaves-types
קבל/api/hrm/holidays-list
קבל/api/hrm/home
פוסט/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-applications
קבל/api/leave-balances
קבל/api/leave-types
קבל/api/payrolls
קבל/api/payrolls/{payroll_id}
קבל/api/payslip/{payroll_entry_id}
קבל/api/promotions
קבל/api/התפטרויות
קבל/api/shifts
קבל/api/terminations
קבל/api/אזהרות

API של צד שלישי (v1) /api/v1/customers

פרוסה יציבה עם גרסה שנבנתה עבור כלים ללא קוד כמו Zapier - לקוחות וחשבוניות. (7 נקודות קצה)

קבל/api/v1/customers
פוסט/api/v1/customers
קבל/api/v1/customers/{id}
PUT/api/v1/customers/{id}
קבל/api/v1/invoices
פוסט/api/v1/invoices
קבל/api/v1/invoices/{id}

נקודות קצה ציבוריות /api/public/plans

עוזרים לא מאומתים: קטלוג התוכניות הציבוריות והווידג'ט של לכידת לידים ותג השותף הניתן להטמעה. (4 נקודות קצה)

קבל/api/badge/{token}
קבל/api/public/plans
פוסט/api/widget/lead
קבל/api/widget/{token}

פלטפורמת תווית לבנה /api/wl/plans

נקודות קצה של שרת לשרת בשימוש על ידי מופעי תווית לבנה עבור חיוב ו-Stripe Connect (מאומת אסימון). (6 endpoints)

פוסט/api/wl/checkout
פוסט/api/wl/connect/onboard
קבל/api/wl/connect/status
קבל/api/wl/plans
פוסט/api/wl/subscription/{stripe_subscription_id}/cancel
פוסט/api/wl/webhook-callback

נקודות קצה של אינטגרציה /api/microsofttodo

נקודות קצה עוזרות לאינטגרציות מחוברות (Microsoft To Do, Vonage SMS, פוסטים בפייסבוק). (3 נקודות קצה)

קבל/api/facebookpost
קבל/api/microsofttodo
קבל/api/vonagesms

עוד נקודות קצה

נקודות קצה רשומות נוספות. (1 נקודות קצה)

קבל/api/agents/{agent}/outstanding-commissions