8cadd00d34
Created by Github action --------- Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com>
56 lines
4.3 KiB
Plaintext
56 lines
4.3 KiB
Plaintext
---
|
||
title: API
|
||
image: /images/docs/getting-started/api.png
|
||
info: גלה כיצד להשתמש ב-API שלנו.
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/docs/getting-started/api.png" alt="Header" />
|
||
</Frame>
|
||
|
||
## סקירה כללית
|
||
|
||
ה-API של Twenty מאפשר למפתחים לעבוד באופן תוכנתי עם פלטפורמת ה-CRM של Twenty. באמצעות ה-API, ניתן לשלב את Twenty עם מערכות אחרות, לאוטומציה של סנכרון נתונים ופיתוח פתרונות מותאמים אישית סביב נתוני הלקוח. ה-API מספק נקודות סיום ליצירה, קריאה, עדכון ומחיקה של אובייקטי CRM מרכזיים (כגון אנשים וחברות) ולגישה להגדרות מטה-נתונים.
|
||
|
||
**מגרש API:** כעת ניתן לגשת למגרש ה-API מתוך הגדרות האפליקציה. כדי לנסות את הקריאות בזמן אמת, התחבר למרחב העבודה של Twenty ועבור אל **הגדרות → APIs & Webhooks**. זה פותח את מגרש ה-API בתוך האפליקציה והגדרות למפתחות API.
|
||
**[עבור להגדרות ה-API](https://app.twenty.com/settings)**
|
||
|
||
## אימות
|
||
|
||
ה-API של Twenty משתמש במפתחות API לאימות משתמש. כל בקשה לנקודות סיום מוגנות חייבת לכלול מפתח API בכותרת.
|
||
|
||
- **מפתחות API:** ניתן ליצור מפתח API חדש מעמוד ההגדרות **API** של אפליקציית Twenty. כל מפתח API הוא סימן סודי שמאפשר גישה לנתוני ה-CRM שלך, ולכן שמור עליו היטב. If a key is compromised, revoke it from the settings and generate a new one.
|
||
- **כותרת אימות:** לאחר שיש לך מפתח API, כלול אותו בכותרת `Authorization` של בקשות ה-HTTP שלך. השתמש בתוכנית Bearer token. לדוגמה:
|
||
|
||
```
|
||
Authorization: Bearer YOUR_API_KEY
|
||
```
|
||
|
||
החלף `YOUR_API_KEY` במפתח שקיבלת. כותרת זו חייבת להופיע בכל **הבקשות ל-API**. אם הסימן חסר או לא תקין, ה-API יגיב עם שגיאת אימות (HTTP 401 Unauthorized).
|
||
|
||
## נקודות סיום API
|
||
|
||
ניתן לגשת לכל המשאבים באמצעות REST או GraphQL.
|
||
|
||
- **ענן:** `https://api.twenty.com/` או הדומיין / תת-דומיין המותאם אישית שלך
|
||
- **Self-Hosted Instances:** If you are running Twenty on your own server, use your own domain in place of `api.twenty.com` (for example, `https://{your-domain}/rest/`).
|
||
|
||
נקודות הסיום מחולקות לשתי קטגוריות: **API ליבה** ו-**API של מטה-נתונים**. ה-**API ליבה** עוסק בנתוני CRM עיקריים (למשל אנשים, חברות, הערות, משימות), בעוד ש-**API של מטה-נתונים** מכסה נתוני תצורה (כמו שדות מותאמים אישית או הגדרות אובייקט). רוב השילובים ישתמשו בעיקר ב-API ליבה.
|
||
|
||
### API ליבה
|
||
|
||
ניגש על `/rest/` או `/graphql/`.
|
||
The **Core API** serves as a unified interface for managing core CRM entities (people, companies, notes, tasks) and their relationships, offering **both REST and GraphQL** interaction models.
|
||
|
||
### API של מטה-נתונים
|
||
|
||
ניגש על `/rest/metadata/` או `/metadata/`.
|
||
נקודות הסיום של ה-API מטה-נתונים מאפשרות לך לקבל מידע על הסכימה וההגדרות שלך. For instance, you can fetch definitions of custom fields, object schemas, etc.
|
||
|
||
- **Example Endpoints:**
|
||
|
||
- `GET /rest/metadata/objects` – רשימת כל סוגי האובייקטים והמטה-נתונים שלהם (שדות, קשרים).
|
||
- `GET /rest/metadata/objects/{objectName}` – קבלת מטה-נתונים עבור אובייקט מסוים (למשל, `אנשים`, `חברות`).
|
||
- `GET /rest/metadata/picklists` – קבלת אפשרויות לשדות של רשימת בוחן (נפילה) המוגדרות ב-CRM.
|
||
|
||
באופן טיפוסי, נקודות הסיום של המטה-נתונים משמשות להבנת מבנה הנתונים (לשילובים דינמיים או בניית טפסים) ולא לניהול רשומות בפועל. הן בדרך כלל לקריאה בלבד. אימות נדרש עבורן גם כן (השתמש במפתח ה-API שלך). |