ממשק פיתוח (Developer API)
ממשק הפיתוח (API) של TourPro מאפשר לסקריפטים ולאינטגרציות שלכם לקרוא את נתוני ה-TourPro שלכם. הגישה מתבצעת באמצעות טוקני גישה אישיים: כל טוקן פועל בשמכם ויכול לראות רק את הסיורים שאתם מורשים לראות.
שלב 1 הוא לקריאה בלבד: ניתן לשלוף את פרטי המשתמש שלכם, את רשימת הסיורים שלכם ואת אירועי לוח הזמנים.
יצירת טוקן
פתיחת הפרופיל
באפליקציית הווב, פתחו את פרופיל (Profile) ובחרו בלשונית Developer.
יצירת הטוקן
לחצו על צור טוקן (Create token), תנו לו שם ברור (למשל, שם הסקריפט או השירות שישתמש בו), ואשרו.
העתקה מיידית
TourPro מציג את הטוקן פעם אחת בלבד. העתיקו אותו ושמרו אותו כמו סיסמה. אם איבדתם אותו, בטלו את הטוקן וצרו טוקן חדש.
קריאה ל-API
שלחו את הטוקן בכותרת האימות כ-Bearer token:
Authorization: Bearer tourpro_...| נקודת קצה (Endpoint) | מה מוחזר |
|---|---|
GET /api/v1/me | מזהה המשתמש, השם וכתובת האימייל שלכם |
GET /api/v1/tours | הסיורים שיש לכם גישה אליהם |
GET /api/v1/tours/:tourId/events | אירועי לוח זמנים של סיור מסוים, מסוננים לפי ההרשאות וכללי הנראות שלכם |
כתובת הבסיס (Base URL) היא שרת ה-API (למשל https://api.tourpro.app), ולא כתובת אפליקציית הווב.
curl https://api.tourpro.app/api/v1/tours \
-H "Authorization: Bearer tourpro_..."ה-API מוגבל לקצב של 120 בקשות בדקה לכל טוקן. מעבר למגבלה תוחזר תשובת 429 עם כותרות RateLimit המתארות את חלון הזמן.
ביטול טוקן
חזרו ללשונית Developer, לחצו על בטל (Revoke) לצד הטוקן המבוקש ואשרו. הביטול נכנס לתוקף באופן מיידי וסופי: צרו טוקן חדש אם תזדקקו לחלופה.
מה טוקן יכול לראות
טוקן לעולם אינו רואה יותר ממה שאתם רואים באפליקציה:
- סיורים: רק סיורים שיצרתם או שאתם חברים בהם.
- אירועים: רק אירועים שגלויים לתפקיד שלכם ולתאריכי הגישה שלכם כאיש אולם באותו סיור, ורק כשיש לכם הרשאת צפייה בלוח הזמנים.
- הכל לקריאה בלבד. שום קריאה ב-API אינה יכולה לשנות את הנתונים שלכם.
התחברויות דפדפן פעילות מהאפליקציה אינן פועלות מול ה-API. נקודות הקצה של v1 מקבלות אך ורק טוקנים עם הקידומת tourpro_, כך שלא ניתן לעשות שימוש חוזר בסשן דפדפן גנוב מולן.