# מבוא ל-API

### סקירה כללית

ה **Pristo API** מאפשר למערכות חיצוניות להשתלב בצורה מאובטחת עם Pristo על מנת לנהל אנשי קשר, לשלוח אירועים ולסנכרן נתונים תפעוליים ונתונים הקשורים ללקוחות.

ממשק ה-API מעוצב באמצעות **גישה RESTful, design-first**, עם כתובות URL מוכוונות משאבים צפויות, שיטות HTTP סטנדרטיות ו-Payloads של JSON מאורגנים.\
כל נקודות הקצה מתועדות ומוצבות בגרסאות כדי להבטיח תאימות לאחור והתפתחות בטוחה לאורך זמן.

תיעוד זה מתאר **Pristo API V1**, אשר מיועד לאינטגרציות בייצור.

###

### כתובת בסיס ה-API וניהול גרסאות

כל הבקשות ל-API נעשות מול כתובת בסיס בגרסה:

```
https://api.pristo.example.com/v1
```

* ניהול הגרסאות מתבצע דרך נתיב ה-URL (`/v1`)
* שינויים שמשבשים תאימות יוכנסו רק בגרסאות ראשיות חדשות
* שיפורים מזעריים ותואמי-לאחור עשויים להתווסף באותה גרסה

### אימות (Authentication)

ממשק ה-API של Pristo משתמש ב **אימות באמצעות מפתח API**.

#### כיצד עובד האימות

* כל בקשה חייבת לכלול מפתח API חוקי
* מפתח ה-API מזהה את מערכת הלקוח ושולט בהרשאות הגישה
* בקשות ללא מפתח API חוקי יידחו

#### כותרת האימות

כלול את מפתח ה-API בכל כותרת בקשה:

```
X-API-Key: YOUR_API_KEY
```

#### הערות אבטחה

* יש לשמור על מפתחות API בסוד ולעולם לא לחשוף אותם בקוד בצד הלקוח
* סובב/י (Rotate) מפתחות API באופן תקופתי בהתאם למדיניות האבטחה שלך
* בקשות על גבי HTTP אינן נתמכות — יש להשתמש ב-HTTPS

###

### הפקת מפתח API

עקוב/י אחר הצעדים הבאים כדי לייצר את המפתח הייחודי שלך:

1\. לחץ/י על **פרופיל** האייקון בפינה הימנית עליונה.

2\. בחר/י **הגדרות חשבון** מהתפריט הנפתח.

<div align="left"><figure><img src="/files/c24018839b6d5dd0fabb006681d4baea18fa1241" alt=""><figcaption></figcaption></figure></div>

3\. נווט/י אל הלשונית **מפתחות API** ולחץ/י על ה"**+הוסף**" כפתור.

<figure><img src="/files/9f0d771a79ab2ab03aa34a21e5986c1dc608a79c" alt=""><figcaption></figcaption></figure>

4. הזן/ה שם תיאורי למפתח כדי שתוכל/י לזהותו בקלות מאוחר יותר.
5. **העתק/י** את המפתח החדש מיד. שמור/י אותו באופן מאובטח, שכן לא יוצג שוב.

{% hint style="info" %}
מפתח ה-API שלך יוצג רק פעם אחת. לא תוכל/י לצפות בו שוב לאחר סגירת החלון.
{% endhint %}

###

### פורמט בקשה ותשובה

#### סוג התוכן

כל הבקשות והתשובות משתמשות ב-JSON:

```
Content-Type: application/json
Accept: application/json
```

#### פורמט תאריך ושעה

כל חותמות הזמן משתמשות ב **ISO 8601** הפורמט ב-UTC:

```
YYYY-MM-DDTHH:mm:ssZ
```

דוגמה:

```
2026-02-04T13:25:00Z
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pristo.io/pristo-docs-he/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.