תיעוד B2B

B2B API – שליפה אוטומטית של מידע על הזמנות ומוצרים

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

אימות

כל בקשות ה-API דורשות API-Key תקף, הנשלח בכותרת HTTP. גישת ה-API מקושרת לחשבון הלקוח שלך וזמינה באופן עקרוני לחשבונות לקוח.

info אינך זקוק לבקשת B2B נפרדת: התחבר עם חשבון הלקוח שלך, פתח את לשונית ה-API וצור שם את ה-API-Key שלך. לגישת API ←

פורמט כותרת

HTTP Request Header
X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

דוגמה עם cURL

cURL
curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

כל נקודות הקצה הן יחסיות ל-Base URL הבא:

Base URL
https://artumos.com/api/v1

כל התגובות מוחזרות כ- JSON (Content-Type: application/json).

Rate Limits

Planבקשות / דקהבקשות / יום
חשבון לקוח605.000
מגבלה מורחבתלפי בקשהלפי בקשה

בעת חריגה מוחזר HTTP 429 Too Many Requests הכותרת Retry-After מכילה את זמן ההמתנה בשניות.

קודי שגיאה

HTTP-Codeמשמעות
200 OKהבקשה הצליחה
400 Bad Requestפרמטרים לא תקפים
401 UnauthorizedAPI-Key חסר או לא תקף
403 Forbiddenאין הרשאה למשאב זה
404 Not Foundהמשאב לא נמצא
429 Too Many Requestsחריגה ממגבלת הקצב
500 Internal Server Errorשגיאת שרת – אנא צור קשר עם התמיכה

פורמט תגובת שגיאה

JSON
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

נקודת קצה: הזמנות

GET /api/v1/orders כל ההזמנות של החשבון
Parameterסוגתיאור
pageintegerעמוד (ברירת מחדל: 1)
per_pageintegerרשומות לעמוד (מקס. 100)
statusstringpaid | pending | all
Beispiel-Response
{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}
GET /api/v1/orders/{order_id} שליפת הזמנה בודדת

נקודת קצה: מידע על מוצרים והזמנות

GET /api/v1/orders/{order_id}/codes כל המידע על מוצרים בהזמנה
Beispiel-Response
{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}
GET /api/v1/codes/{code_id} שליפת מידע על מוצר בודד
warning מידע על מוצרים והזמנות מותר לשימוש רק במסגרת ההזמנה ופרטי המוכר הרלוונטיים. העברה לרעה עלולה להפר את תנאי השימוש.

נקודת קצה: מוצרים

GET /api/v1/products שליפת קטלוג מוצרים
Parameterסוגתיאור
categorystringסינון לפי slug של קטגוריה
in_stockbooleanרק מוצרים זמינים
pageintegerעמוד
Beispiel-Response
{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Webhooks מאפשרים לקבל התראות בזמן אמת כאשר הזמנות או קודים מסופקים. ניתן להגדיר Webhook-URLs בחשבון הלקוח.

אירועים זמינים

Eventתיאור
order.paidההזמנה שולמה
codes.deliveredהקודים סופקו
order.refundedההזמנה זוכתה

Webhook Payload

POST – ה-Webhook-Endpoint שלך
{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

אמת את החתימה עם ה-Webhook-Secret שלך: HMAC-SHA256(payload, webhook_secret)

שאלות נפוצות

מי יכול להשתמש ב-B2B API?

כל לקוח עם חשבון לקוח יכול להשתמש בגישת ה-API. התחבר לחשבון הלקוח שלך והשתמש ב-API-Key המתאים לבקשות מאומתות.

באיזה פורמט הן התגובות?

כל התגובות מוחזרות כ-JSON. אובייקט השורש מכיל תמיד success: true/false וכן או data או error.

האם אני יכול לבצע הזמנות דרך ה-API?

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

האם קיימת סביבת Sandbox?

כן. ניתן להפעיל את ה-Sandbox בחשבון הלקוח בלשונית „גישת API" והיא מקושרת ישירות ל-API-Key הרלוונטי.