התחלת עבודה עם ה-API

התחלת עבודה עם Hostey API

ה-API של Hostey מאפשר לנהל שירותים, פניות וחשבון באופן תכנותי. ניתן להשתמש בו לאוטומציה, אינטגרציה עם מערכות חיצוניות, בניית לוחות בקרה מותאמים ועוד.

יצירת מפתח API

1. היכנסו לפורטל > חשבון > מפתחות API
2. לחצו "יצירת מפתח חדש"
3. תנו למפתח שם תיאורי (לדוגמה: "סקריפט ניטור" או "אינטגרציית CRM")
4. לחצו "יצירה"
5. חשוב: העתיקו את המפתח מיד. הוא יוצג פעם אחת בלבד ולא ניתן לשחזר אותו.

אימות (Authentication)

כל בקשה ל-API חייבת לכלול מפתח API בכותרת (Header):

Authorization: Bearer YOUR_API_KEY

כתובת בסיס

כל הבקשות נשלחות לכתובת:

https://hostey.co.il/api/v1/

בקשה ראשונה - פרטי חשבון

לבדיקה שהמפתח עובד, שלחו בקשת GET לנקודת הקצה /account:

cURL

curl -X GET https://hostey.co.il/api/v1/account \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

JavaScript (fetch)

const response = await fetch('https://hostey.co.il/api/v1/account', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await response.json();
console.log(data);

Python (requests)

import requests

response = requests.get(
    'https://hostey.co.il/api/v1/account',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    }
)
print(response.json())

תשובה לדוגמה

{
  "id": "abc123",
  "name": "ישראל ישראלי",
  "email": "israel@example.co.il",
  "company": "חברת הדוגמה בע"מ"
}

נקודות קצה (Endpoints) זמינות

Method	Endpoint	תיאור
GET	/account	פרטי חשבון
GET	/services	רשימת שירותים
GET	/services/:id	פרטי שירות
GET	/tickets	רשימת פניות
POST	/tickets	פתיחת פנייה חדשה
GET	/tickets/:id	פרטי פנייה

קודי תשובה

• 200 - הצלחה
• 401 - מפתח API לא תקין או חסר
• 403 - אין הרשאה לפעולה זו
• 404 - המשאב לא נמצא
• 429 - חריגה ממגבלת בקשות (Rate Limit)
• 500 - שגיאת שרת

הגבלת בקשות (Rate Limiting)

ה-API מגביל את מספר הבקשות למניעת עומס. המגבלה הנוכחית היא 60 בקשות לדקה. אם חורגים מהמגבלה, תוחזר שגיאה 429.

אבטחה

• אל תשתפו את מפתח ה-API עם אף אחד
• אל תכניסו את המפתח לקוד מקור ציבורי (GitHub)
• השתמשו במשתני סביבה (environment variables) לשמירת המפתח
• אם מפתח נחשף, בטלו אותו מיד וצרו חדש