ה 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 בכל כותרת בקשה:
הערות אבטחה
יש לשמור על מפתחות API בסוד ולעולם לא לחשוף אותם בקוד בצד הלקוח
סובב/י (Rotate) מפתחות API באופן תקופתי בהתאם למדיניות האבטחה שלך
בקשות על גבי HTTP אינן נתמכות — יש להשתמש ב-HTTPS
הפקת מפתח API
עקוב/י אחר הצעדים הבאים כדי לייצר את המפתח הייחודי שלך:
1. לחץ/י על פרופיל האייקון בפינה הימנית עליונה.
2. בחר/י הגדרות חשבון מהתפריט הנפתח.
3. נווט/י אל הלשונית מפתחות API ולחץ/י על ה"+הוסף" כפתור.
הזן/ה שם תיאורי למפתח כדי שתוכל/י לזהותו בקלות מאוחר יותר.
העתק/י את המפתח החדש מיד. שמור/י אותו באופן מאובטח, שכן לא יוצג שוב.
מפתח ה-API שלך יוצג רק פעם אחת. לא תוכל/י לצפות בו שוב לאחר סגירת החלון.
