github-actions[bot]
9bc5486d0d
Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
131 lines
5.9 KiB
Plaintext
131 lines
5.9 KiB
Plaintext
---
|
||
title: APIs Overview
|
||
info: הבינו את ארבעת סוגי ה-API השונים ומתי להשתמש בכל אחד מהם.
|
||
image: /images/user-guide/api/api-overview.png
|
||
sectionInfo: למדו כיצד לחבר את Twenty לכלים האחרים שלכם.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/user-guide/api/api-overview.png" alt="Header" />
|
||
</Frame>
|
||
|
||
Twenty נבנתה להיות ידידותית למפתחים, עם APIs חזקים המותאמים למודל הנתונים המותאם אישית שלכם. אנו מספקים ארבעה סוגי API שונים בשביל צרכי אינטגרציה שונים.
|
||
|
||
## Developer-First Approach
|
||
|
||
Twenty generates APIs specifically for your data model, meaning:
|
||
|
||
- אין צורך במזהים ארוכים: השתמשו בשמות האובייקט והשדות שלכם ישירות בנקודות קצה
|
||
- אובייקטים סטנדרטיים ומותאמים אישית מטופלים באופן שווה: האובייקטים המותאמים אישית שלכם מקבלים את אותו טיפול API כמו האובייקטים המובנים
|
||
- נקודות קצה ייעודיות: כל אובייקט ושדה מקבל נקודת קצה API ייחודית
|
||
- **Custom documentation**: Generated specifically for your workspace's data model
|
||
|
||
<Warning>
|
||
ה-API המותאם שלכם יוצר תיעוד אישי שניתן לגישה דרך הגדרות → API & Webhooks לאחר יצירת מפתח API. תיעוד זה משקף את מודל הנתונים המדויק והתקנות השדות שלכם.
|
||
</Warning>
|
||
|
||
## ארבעת סוגי ה-API
|
||
|
||
Twenty מציעה APIs בפורמטים של **REST** ו-**GraphQL**:
|
||
|
||
### REST APIs
|
||
|
||
#### 1. REST Metadata API
|
||
|
||
- מטרה: ניהול מבנה סביבת העבודה ומודל הנתונים
|
||
- מקרים לשימוש:
|
||
- יצירה, שינוי או מחיקה של אובייקטים ושדות
|
||
- הגדרת הגדרות סביבת עבודה
|
||
- ניהול מערכות יחסים במודל הנתונים
|
||
- גישה: זמינה דרך נקודות קצה REST
|
||
|
||
#### 2. REST Core API
|
||
|
||
- מטרה: ניהול רשומות הנתונים האמיתיות שלכם
|
||
- מקרים לשימוש:
|
||
- יצירה, קריאה, עדכון או מחיקה של רשומות
|
||
- שאילתת נתונים ספציפיים
|
||
- ניהול מערכות יחסים ברשומות
|
||
- גישה: זמינה דרך נקודות קצה REST
|
||
|
||
### APIs של GraphQL
|
||
|
||
#### 3. GraphQL Metadata API
|
||
|
||
- מטרה: כמו API מטאדאטה של REST, אך עם יתרונות GraphQL
|
||
- מקרים לשימוש: ניהול סביבת עבודה ומודל נתונים זהה
|
||
- יתרונות נוספים:
|
||
- שאילתת סוגי מטאדאטה מרובים בבקשה אחת
|
||
- בחירה מדויקת של שדות
|
||
- ביצועים טובים יותר לשאילתות מורכבות
|
||
|
||
#### 4. API ליבה של GraphQL
|
||
|
||
- מטרה: כמו API ליבה של REST, אך עם יתרונות GraphQL
|
||
- מקרים לשימוש: ניהול רשומות נתונים זהה
|
||
- יתרונות נוספים:
|
||
- פעולות קבוצתיות: זמינות עבור כל הפעולות
|
||
- פעולות עדכן יצירה (Upsert): יצירה או עדכון רשומות בקריאה אחת
|
||
- שאילתת מערכות יחסים בבקשות יחידות
|
||
- שאיבת נתונים מדויקת
|
||
|
||
## פעולות קבוצתיות
|
||
|
||
### תמיכה בפעולות קבוצתיות ב-REST ו-GraphQL
|
||
|
||
שני הפורמטים של REST ו-GraphQL תומכים בפעולות קבוצתיות עבור רוב הפעולות:
|
||
|
||
- גודל הקבוצה: עד 60 רשומות לכל בקשה
|
||
- פעולות זמינות: יצירה, עדכון, מחיקת רשומות מרובות
|
||
- ביצועים: מהירים בצורה משמעותית מקריאות API יחידניות
|
||
|
||
### תכונות בלעדיות ל-GraphQL
|
||
|
||
- עדכן יצירה קבוצתי: זמין רק ב-GRAPHQL APIs
|
||
- שימוש: השתמשו בשמות אובייקטים ברבים (למשל, `CreateCompanies` במקום `CreateCompany`)
|
||
- דרישה: זו הסיבה לכך ששמות אובייקטים ויחיד ורבים צריכים להיות שונים
|
||
|
||
## גישה לתיעוד API
|
||
|
||
1. גשו ל**הגדרות → API & Webhooks**
|
||
2. צרו מפתח API (נדרש לגישה לתיעוד)
|
||
3. גשו אל התיעוד המותאם והפלייגראונד שלכם
|
||
4. בדקו APIs עם מודל הנתונים האמיתי שלכם
|
||
|
||
התיעוד שלכם ייחודי לסביבת העבודה שלכם מאחר שהוא משקף את האובייקטים המותאמים שלך, השדות והקישורים.
|
||
|
||
## מתי להשתמש בכל API
|
||
|
||
### השתמשו במטאדאטה APIs כאשר:
|
||
|
||
- הגדרת מודל הנתונים
|
||
- יצירה של אובייקטים או שדות מותאמים אישית
|
||
- הגדרת הגדרות סביבת עבודה
|
||
|
||
### השתמשו בליבה APIs כאשר:
|
||
|
||
- ניהול נתוני היום-יום (אנשים, חברות, הזדמנויות)
|
||
- שילוב עם מערכות חיצוניות
|
||
- בניית יישומים מותאמים
|
||
- אוטומציה של תהליכי עבודה בנתונים
|
||
|
||
### בחרו ב-GraphQL כאשר:
|
||
|
||
- אתם זקוקים לפעולות קבוצתיות
|
||
- אתם מעוניינים לצמצם קריאות API
|
||
- אתם זקוקים לפונקציונליות עדכן יצירה
|
||
- כשאתם בונים אינטגרציות מורכבות
|
||
|
||
### בחרו ב-REST כאשר:
|
||
|
||
- אתם מעדיפים מבנה API פשוט
|
||
- כשאתם בונים אינטגרציות בסיסיות
|
||
- כשצוותכם מכיר היטב את REST
|
||
- אתם זקוקים לפעולות CRUD ישירות
|
||
|
||
## השלבים הבאים
|
||
|
||
- **[הגדרת API ו-Webhook](/l/he/user-guide/integrations-api/api-webhooks)**: למדו כיצד ליצור מפתחות API ו-Webhooks
|
||
- **תיעוד מותאם אישית**: גשו אל התיעוד האישי שלכם דרך הגדרות → API & Webhooks
|
||
|