B2B API – שליפה אוטומטית של מידע על הזמנות ומוצרים
ה-REST API שלנו זמין לכל לקוח עם חשבון לקוח ומאפשר לשלוף מידע על הזמנות ומוצרים באופן אוטומטי ולשלב אותו במערכות משלכם.
אימות
כל בקשות ה-API דורשות API-Key תקף, הנשלח בכותרת HTTP. גישת ה-API מקושרת לחשבון הלקוח שלך וזמינה באופן עקרוני לחשבונות לקוח.
פורמט כותרת
X-API-Key: YOUR_API_KEY_HERE Content-Type: application/json Accept: application/json
דוגמה עם 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 הבא:
https://artumos.com/api/v1
כל התגובות מוחזרות כ- JSON (Content-Type: application/json).
Rate Limits
| Plan | בקשות / דקה | בקשות / יום |
|---|---|---|
| חשבון לקוח | 60 | 5.000 |
| מגבלה מורחבת | לפי בקשה | לפי בקשה |
בעת חריגה מוחזר HTTP 429 Too Many Requests הכותרת Retry-After מכילה את זמן ההמתנה בשניות.
קודי שגיאה
| HTTP-Code | משמעות |
|---|---|
200 OK | הבקשה הצליחה |
400 Bad Request | פרמטרים לא תקפים |
401 Unauthorized | API-Key חסר או לא תקף |
403 Forbidden | אין הרשאה למשאב זה |
404 Not Found | המשאב לא נמצא |
429 Too Many Requests | חריגה ממגבלת הקצב |
500 Internal Server Error | שגיאת שרת – אנא צור קשר עם התמיכה |
פורמט תגובת שגיאה
{
"success": false,
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key."
}
}
נקודת קצה: הזמנות
/api/v1/orders
כל ההזמנות של החשבון
| Parameter | סוג | תיאור |
|---|---|---|
page | integer | עמוד (ברירת מחדל: 1) |
per_page | integer | רשומות לעמוד (מקס. 100) |
status | string | paid | pending | all |
{
"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
}
}
}
/api/v1/orders/{order_id}
שליפת הזמנה בודדת
נקודת קצה: מידע על מוצרים והזמנות
/api/v1/orders/{order_id}/codes
כל המידע על מוצרים בהזמנה
{
"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"
}
]
}
}
/api/v1/codes/{code_id}
שליפת מידע על מוצר בודד
נקודת קצה: מוצרים
/api/v1/products
שליפת קטלוג מוצרים
| Parameter | סוג | תיאור |
|---|---|---|
category | string | סינון לפי slug של קטגוריה |
in_stock | boolean | רק מוצרים זמינים |
page | integer | עמוד |
{
"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
{
"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)
שאלות נפוצות
כל לקוח עם חשבון לקוח יכול להשתמש בגישת ה-API. התחבר לחשבון הלקוח שלך והשתמש ב-API-Key המתאים לבקשות מאומתות.
כל התגובות מוחזרות כ-JSON. אובייקט השורש מכיל תמיד success: true/false וכן או data או error.
בגרסה הראשונה ה-API משמש לשליפת הזמנות, מידע על הזמנות ומוצרים. נקודות קצה לכתיבת הזמנות ייפתחו בנפרד ברגע שיהיו זמינות.
כן. ניתן להפעיל את ה-Sandbox בחשבון הלקוח בלשונית „גישת API" והיא מקושרת ישירות ל-API-Key הרלוונטי.