בית תיעוד API נקודות קצה רישיונות

נקודות קצה רישיונות

עודכן לאחרונה ב-Mar 21, 2026

נקודות קצה רישיונות

מדריך זה מתעד את נקודות קצה ה-API לאימות, הפעלה וניהול רישיונות.


GET /license/check_license

אימות האם מפתח רישיון פעיל ומשויך לדומיין.

URL: https://app.shipos.co.il/api/license/check_license שיטה: GET

פרמטרי שאילתה

פרמטר סוג תיאור חובה
license_key string מפתח הרישיון לאימות כן
domain string דומיין החנות כן

דוגמת בקשה

curl -X GET "https://app.shipos.co.il/api/license/check_license?license_key=LIC-12345&domain=mystore.com"

תגובת הצלחה (200) - רישיון תקין

{
  "success": true,
  "data": {
    "license_key": "LIC-12345",
    "domain": "mystore.com",
    "is_active": true,
    "company_id": 42,
    "company_name": "Zig Zag",
    "expires_at": "2027-03-15T00:00:00Z",
    "features": {
      "pickup_points": true,
      "express_delivery": true,
      "cod": true
    }
  }
}

💡 טיפ: קראו לנקודת קצה זו בהפעלת תוסף או בבדיקות בריאות כדי לוודא שהרישיון עדיין תקף.


GET /license/activate_license

הפעלת מפתח רישיון וקשירתו לדומיין ספציפי.

URL: https://app.shipos.co.il/api/license/activate_license שיטה: GET

פרמטרי שאילתה

פרמטר סוג תיאור חובה
license_key string מפתח הרישיון להפעלה כן
domain string דומיין החנות לקשירה כן

⚠️ אזהרה: מפתח רישיון יכול להיות קשור רק לדומיין אחד בכל פעם. אם צריך להעביר רישיון לדומיין אחר, בטלו אותו קודם ואז הפעילו מחדש בדומיין החדש.


POST /licenses

רשימת כל הרישיונות המשויכים למשתמש המאומת. נקודת קצה זו דורשת אימות Sanctum (ברמת משתמש, לא ברמת רישיון).

URL: https://app.shipos.co.il/api/licenses שיטה: POST אימות: Sanctum Bearer Token

דוגמת בקשה

curl -X POST https://app.shipos.co.il/api/licenses \
  -H "Authorization: Bearer YOUR_SANCTUM_TOKEN" \
  -H "Accept: application/json"

הערה: נקודת קצה זו דורשת טוקן Sanctum שמתקבל דרך זרימת ההתחברות. היא משמשת בעיקר את לוח הבקרה וממשקי הניהול של ShipOS, לא תוספי חנות.


מחזור חיי רישיון

                  activate_license
   לא פעיל  ─────────────────────>  פעיל
      ^                                 │
      │                                 │
      │         expires_at הגיע         │
      │<────────────────────────────────│
      │                                 │
      │         ביטול                   │
      │<────────────────────────────────│

מצבי רישיון

מצב תיאור
פעיל רישיון תקף וניתן לשימוש למשלוחים
לא פעיל רישיון מבוטל או טרם הופעל
פג תוקף רישיון עבר את תאריך התפוגה

מקרי שימוש נפוצים

אימות בהפעלת תוסף

כשתוסף חנות מופעל, בדקו את הרישיון:

# שלב 1: בדקו אם הרישיון תקף
curl -X GET "https://app.shipos.co.il/api/license/check_license?license_key=LIC-12345&domain=mystore.com"

# שלב 2: אם לא מופעל, הפעילו
curl -X GET "https://app.shipos.co.il/api/license/activate_license?license_key=LIC-12345&domain=mystore.com"

בדיקת בריאות תקופתית

אמתו את הרישיון מעת לעת (למשל מדי יום דרך cron) כדי לוודא שלא פג:

curl -X GET "https://app.shipos.co.il/api/license/check_license?license_key=LIC-12345&domain=mystore.com"

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


צעדים הבאים