API Mewayz תוסף
גלה את העוצמה של שילוב ה-API של Mewayz לניהול חלק של פרויקטים ומשימות. להרחיב ולהתאים אישית בקלות. נסה עכשיו!
הקדמה
מחולל ה-API Docs הוא תוסף רב עוצמה המספק תיעוד API מלא עבור פלטפורמת Mewayz. תוסף זה עוזר למפתחים ולצוותים טכניים לגשת למידע מפורט על API, כולל נקודות קצה, כותרות, פרמטרים ודוגמאות תגובה. התיעוד מכסה 14 מודולים עיקריים של הפלטפורמה ומאפשר למשתמשים לבנות יישומים מותאמים אישית, לשלב מערכות חיצוניות או לבדוק ממשקי API באופן ידני באמצעות כלים כמו Postman.
כיצד להפעיל מודול זה
כדי להגדיר את תוסף ה-API, אתה יכול לעקוב אחר הקישור הזה: הגדר תוסף.
כיצד להשתמש בתוסף API?
צור Api Docs
לאחר רכישה והתקנה של תוסף זה, עבור לסרגל הצד של לוח המחוונים וחפש את תוסף ה-API Docs.
כדי לגשת לתיעוד ה-API, נווט לקטע Api Docs ממרכז השליטה הראשי שלך. התיעוד מאורגן על ידי 14 מודולים, מה שמקל על מציאת ממשקי ה-API הספציפיים שאתה צריך עבור פרויקט האינטגרציה שלך.
הסעיף כולל מבוא כללי המסביר כיצד להשתמש בממשקי ה-API ביעילות. סקירה כללית זו מכסה דרישות אימות, כותרות נפוצות והנחיות שימוש בסיסיות החלות בכל נקודות הקצה של ה-API.
כל מודול מכיל רישומי API רבי עוצמה עם פרטים טכניים מלאים. עבור כל נקודת קצה API, תמצא את שם ה-API, כתובת האתר המדויקת של נקודת הקצה, כותרות נדרשות לאימות ופורמט נתונים, פרמטרי קלט עם סוגי הנתונים וכללי האימות שלהם, תגובות הצלחה לדוגמה המציגות את מבנה הנתונים הצפוי ותגובות שגיאה לדוגמה עם קודי שגיאה והודעות נפוצות.
ניהול מבוא
תיעוד API מקיף זה הוא השער שלך לניצול העוצמה של התכונות של Mewayz, המאפשר לך לייעל את עבודתך, להגביר את הפרודוקטיביות ולהביא את הפרויקטים שלך לשלב הבא.
תיעוד API זה הוא משאב עבור מפתחים, ותיקים וחדשים כאחד, שרוצים למנף את היכולות של Mewayz בתוך היישומים שלהם. הנה מה שאתה יכול לצפות למצוא.
אתה יכול לעיין בהפניה האינטראקטיבית המלאה בתוך המוצר תחת הגדרות ← API Docs.
סעיף נקודות הקצה מכסה GET לאחזור נתונים, POST ליצירת נתונים חדשים, POST לעדכון נתונים קיימים ומחיקה להסרת נתונים. אתה יכול להשתמש בשיטות HTTP כמו GET כדי לאחזר נתונים, POST כדי ליצור נתונים חדשים, POST כדי לעדכן נתונים קיימים, ו-DELETE כדי להסיר נתונים.
פרמטרי בקשות משמשים כדי להתאים אישית את ההתנהגות של בקשות ה-API שלך ולספק פרטים ספציפיים יותר בעת אינטראקציה עם ה-API. עבור Mewayz, ייתכן שיש לך את הסוגים הבאים של פרמטרים של בקשה: פרמטרי שאילתה לסינון או מיון נתונים בעת אחזור מידע, כותרות בקשה לאימות ומטא נתונים נוספים לגבי הבקשה, וגוף הבקשה המכיל נתוני JSON ליצירה או עדכון.
ה-API של Mewayz בדרך כלל מגיב עם נתונים בפורמט JSON. התגובה כוללת בדרך כלל קוד סטטוס HTTP המציין את תוצאת הבקשה, והנתונים בפועל כלולים בתוך "נתונים" שדה.
ניהול אימות
ממשקי API של אימות מספקים את פונקציונליות ההתחברות החיונית, יכולות רענון אסימון לתחזוקת הפעלות ונהלי התנתקות להפעלות משתמש קצה בצורה מאובטחת.
נקודת הקצה של ההתחברות POST /api/login דורשת כותרות עם "קבל": "application/json" ופרמטרים כולל מייל כמו "[email protected]" וסיסמה כמו **"john****"**.
תגובות שגיאה מחזירות 422 תוכן בלתי ניתן לעיבוד עם "הצלחה": שקר, "הודעה": "אימות כאשר אימות הוא שגיאה.
תגובות שגיאה מחזירות 400 לא מורשה עם "הצלחה": שקר, "הודעה": "המסופק" כאשר האישורים אינם חוקיים.
תגובות כניסה מוצלחות מחזירות 200 בסדר עם "הצלחה": true והרשאה המכילה אסימון וסוג "נושא" עבור קריאות API עוקבות.
נקודת הקצה של ה-Auth Refresh POST /api/refresh משתמש בכותרות הרשאה עם אסימון Bearer לניהול הפעלה.
תגובות רענון מוצלחות מחזירות מידע מפורט על המשתמש, כולל 200 בסדר עם "הצלחה": true, ופרטי משתמש, id, name, email, mobile_no, הקלד: "חברה", דמות: "כתובת אתר", לאנג: "he" ואסימון.
ניהול משתמשים
- ממשקי API למשתמשים לניהול משתמשים, ניהול תפקידים ופרופיל
פעולות.
ניהול מחסן
- ממשקי API של מחסן לתצורת מחסן והעברת מחסנים
ניהול.
ניהול מוצר ושירות
- ממשקי API של מדור מוצרים ושירות מנהלים קטגוריות מוצרים, מיסים,
יחידות מדידה, מוצרים וניהול מלאי עם שילוב מחסן.
ניהול חשבוניות רכישה
- ממשקי API של חשבוניות רכש עבור רשימת חשבוניות רכישה, יצירה, פירוט,
עדכון, מחיקה, ניהול פוסט חשבונית.
ניהול החזרת רכש
- ממשקי API לטיפול ברשימת החזרות רכישה, יצירה, פירוט החזרה,
מחק, אישור, השלם עיבוד.
ניהול הצעות מכירות
- ממשקי API של הצעות מכירות לניהול והמרה של הצעות
תהליכים.
ניהול חשבוניות מכירה
- ממשקי API של חשבוניות מכירה מטפלים ברשימת חשבוניות, יצירה, עדכון, מחיקה,
ניהול דואר חשבוניות.
ניהול החזרת חשבוניות מכירה
- ממשקי API לניהול רשימת החזרת חשבוניות מכירה, יצירה, פירוט, מחק,
אשר והשלם.
ניהול חשבון
- ממשקי API של חלק החשבון מאפשרים לך לנהל לקוחות, ספקים,
- מודול החשבון כולל ממשקי API של רשימה מהירה לאחזור פשוט
חשבונות בנק, תרשים חשבונות, הכנסות, הוצאות, שטרי אשראי, שטרי חיוב, תשלומי ספקים, תשלומי לקוחות, עסקאות בנקאיות, רישומי העברות בנקאיות. אתה יכול לבצע פעולות כמו רישום רשומות, יצירת ערכים חדשים, הצגת פרטים, עדכון מידע ומחיקת רשומות לפי הצורך.
רשימות לקוחות וספקים, רשימת חשבונות Gl, יחד עם קטגוריות הכנסות והוצאות לבחירות נפתחות והפניות מהירות.
ניהול פרויקטים
- ממשקי API של קטע פרויקטים מנהלים פרויקטים, משימות, באגים, אבני דרך,
קבצים, ודוחות שונים עם השלבים וזרימות העבודה הקשורים אליהם.
ניהול קופה
- ממשקי POS API מטפלים בפעולות בנקודות המכירה, כולל ניהול הזמנות
ופרטי הזמנה.
ניהול CRM
- ממשקי API של סעיף CRM מכסים את שלבי ניהול הצינורות, ההובלה והעסקה,
תוויות, מקורות וניהול לידים מלא וניהול עסקות. אתה יכול לנהל משימות, משתמשים, מוצרים, מקורות, מיילים, דיונים, קבצים ושיחות הקשורות הן ללידים והן לעסקאות.
ניהול HRM
- ממשקי API של HRM מטפלים בניהול עובדים, במבנה ארגוני,
מעקב נוכחות, ניהול חופשות, עיבוד שכר ורישומי משאבי אנוש שונים, לרבות פרסים, קידומי מכירות, התפטרות, פיטורים, אזהרות, תלונות, העברות עובדים, חגים, אירועים, מסמכים, הודעות ותודות.
כל נקודת קצה של API בתיעוד כוללת דוגמאות מעשיות שתוכל להעתיק ולהשתמש ישירות בסביבת הפיתוח או בכלי הבדיקה שלך. דוגמאות התגובה מציגות גם פעולות מוצלחות וגם תרחישי שגיאה נפוצים, ועוזרות לך ליישם טיפול נכון בשגיאות ביישומים שלך.
רשימת ממשקי API של מודולים חכמים:
- אימות:
- כְּנִיסָה לַמַעֲרֶכֶת
- רענון אסימון
- התנתק
- משתמש:
- משתמש: רשום, צור, עדכן, מחק,
- תפקיד: רשימה
- יומן משתמש: רשימה
- משתמשי צוות: רשימה
- משתמשי לקוח: רשימה
- משתמשי ספקים: רשימה
- מחסן:
עדכון פרופיל, עדכון סיסמה, אפס סיסמה, אימות
- מחסן: רשימה, צור, פירוט, עדכן,
- העברה: רשימה, צור נתוני בקשה,
- מוצר ושירות:
מחק
צור, מחק
- קטגוריית מוצרים: רשום, צור, עדכן,
- מס: רשום, צור, עדכן, מחק
- יחידה: רשום, צור, עדכן, מחק
- מוצר: רשימה, צור, פירוט, עדכן,
- מלאי מוצר: רשימה, הוסף
- מוצר מחסן: רשימה
- חשבונית רכישה:
מחק
מחק
- חשבונית: רשימה, צור, פירוט, עדכן,
- החזרת רכישה:
מחק, פרסם
- החזרה: רשימה, צור, פירוט, מחק,
- הצעת מכירה:
אשר, השלם
- הצעה: רשימה, צור, פירוט, עדכן,
- חשבונית מכירה:
מחק, שלח, קבל, דחה, המר לחשבונית
- חשבונית: רשימה, צור, פירוט, עדכן,
- החזרת חשבונית מכירה:
מחק, פרסם
- החזרה: רשימה, צור, פירוט, מחק,
- חשבון:
אשר, השלם
- קבל לקוחות: רשימת לקוחות פשוטה
- קבל ספקים: רשימת ספקים פשוטה
- לקוח: רשום, צור, עדכן, מחק
- ספק: רשום, צור, עדכן, מחק
- חשבון Gl: רשימה
- חשבון בנק: רשום, צור, עדכן, מחק
- קטגוריות הכנסות: רשימה
- הכנסה: רשום, צור, עדכן, מחק,
- קטגוריות הוצאות: רשימה
- הוצאה: רשום, צור, עדכן, מחק,
- סוגי חשבונות: רשימה
- טבלת חשבון: רשימה
- עסקה בנקאית: רשימה
- העברה בנקאית: רשימה
- תשלומי ספקים: רשימה
- תשלומי לקוחות: רשימה
- הערת אשראי: רשימה
- הערת חיוב: רשימה
- פרויקט:
אשר, פרסם
אשר, פרסם
- פרויקט: רשימה, צור, פירוט, עדכן,
- חבר בפרויקט: מחק
- לקוח הפרויקט: רשום, הזמן, מחק
- אבן דרך של פרויקט: רשום, צור, עדכן,
- קובץ פרויקט: צור, מחק
- משימה: לוח משימות, יצירה, פירוט, עדכון,
- הערת משימה: צור, מחק
- משימה משנה: צור, עדכן
- סטטוס באג: רשימה
- באג: רשימה, צור, פירוט, עדכן, מחק
- הערת באג: צור, מחק
- דוח פרויקט: רשימה, פירוט
- שלב המשימות: רשימה, סדר, צור, עדכן,
- שלב באג: רשימה, סדר, צור, עדכן,
- קופה:
מחק
מחק
מחק
מחק
מחק
- הזמנה: רשימה, פירוט
- CRM:
- צינור: רשום, צור, עדכן, מחק
- שלב מוביל: רשום, צור, עדכן, מחק
- שלב העסקה: רשום, צור, עדכן, מחק
- תוויות: רשום, צור, עדכן, מחק
- מקורות: רשום, צור, עדכן, מחק
- עופרת: רשימה, צור, פירוט, עדכן,
- משימה מובילה: צור, עדכן, מחק
- משתמש מוביל: צור, מחק
- מוצר מוביל: צור, מחק
- מקור מוביל: צור, מחק
- דוא"ל מוביל: צור
- דיון מוביל: צור
- קובץ לידים: צור, מחק
- שיחה מובילה: צור, עדכן, מחק
- עסקה: רשימה, צור, פירוט, עדכן,
- משימת עסקה: צור, עדכן, מחק
- משתמש עסקה: צור, מחק
- מוצר עסקה: צור, מחק
- מקור העסקה: צור, מחק
- אימייל עסקה: צור
- דיון עסקה: צור
- קובץ עסקה: צור, מחק
- לקוח עסקה: צור, מחק
- שיחת עסקה: צור, עדכן, מחק
- HRM:
מחק, הוסף תווית, המר לעסקה
מחק, הוסף תווית
- עובד: רשימה, צור, פירוט, עדכן,
- נוכחות: רשום, צור, עדכן, מחק
- סוגי השאירים: רשימה
- השאר יישומים: רשום, צור, עדכן,
- השאר יתרות: בדוק
- שכר: רשימה, פירוט
- תלוש שכר: צור
- משמרות: רשימה
- סניפים: רשימה
- מחלקות: רשימה
- ייעודים: רשימה
- סוגי מסמכים: רשימה
- חגים: רשימה
- פרסים: רשימה
- מבצעים: רשימה
- התפטרויות: רשימה
- סיום: רשימה
- אזהרות: רשימה
- תלונות: רשימה
- העברות עובדים: רשימה
- מסמכים: רשימה
- תודות: רשימה
- הכרזות: רשימה
- אירועים: רשימה
מחק
מחק, עדכן סטטוס