API v1.0

QuickShopPublic API

REST API מלא לאינטגרציה עם חנויות QuickShop.
הזמנות, מוצרים, מלאי ולקוחות - הכל בגישת API.

Base URL
https://my-quickshop.com/api/v1

התחלה מהירה

1

צרו API Key

היכנסו לאדמין → Settings → API Keys ויצרו מפתח חדש עם ה-Scopes הרלוונטיים.

2

הוסיפו את ה-Header

כל קריאה דורשת Header בשם X-API-Key עם המפתח שלכם.

3

התחילו לבנות

קראו את התיעוד המלא ותתחילו לבנות אינטגרציות מדהימות!

Example Request
curl -X GET "https://my-quickshop.com/api/v1/orders" \
  -H "X-API-Key: qs_live_xxxxxxxxxxxxxxxxxxxx"

אימות (Authentication)

כל הקריאות דורשות API Key

Scopes זמינים

orders:readצפייה בהזמנות
orders:writeעדכון הזמנות
products:readצפייה במוצרים
products:writeיצירה/עריכה/מחיקת מוצרים
customers:readצפייה בלקוחות
inventory:readצפייה במלאי
inventory:writeעדכון מלאי
analytics:readצפייה באנליטיקס
webhooks:writeניהול וובהוקים

Rate Limiting

  • 100 requests/minute per API key
  • • Header X-RateLimit-Remaining - כמה קריאות נשארו
  • • Header X-RateLimit-Reset - מתי יתאפס המונה

שגיאות נפוצות

401unauthorized- API key לא תקין או חסר
403forbidden- אין הרשאה (scope חסר)
404not_found- משאב לא נמצא
400invalid_request- בקשה לא תקינה
429rate_limited- חריגה ממגבלת קריאות

Endpoints

Orders

GET/api/v1/ordersרשימת הזמנות
GET/api/v1/orders/{id}פרטי הזמנה
PATCH/api/v1/orders/{id}עדכון הזמנה

Products

GET/api/v1/productsרשימת מוצרים
GET/api/v1/products/{id}פרטי מוצר
PATCH/api/v1/products/{id}עדכון מוצר

Inventory

GET/api/v1/inventory/{id}צפייה במלאי
PATCH/api/v1/inventory/{id}עדכון מלאי

Customers

GET/api/v1/customersרשימת לקוחות
GET/api/v1/customers/{id}פרטי לקוח

דוגמאות קוד

Node.js
const API_KEY = 'qs_live_xxxx';
const BASE_URL = 'https://my-quickshop.com/api/v1';

async function getOrders() {
  const response = await fetch(`${BASE_URL}/orders`, {
    headers: {
      'X-API-Key': API_KEY,
    },
  });
  
  const { data, meta } = await response.json();
  return data;
}

async function updateInventory(productId, adjustment) {
  const response = await fetch(`${BASE_URL}/inventory/${productId}`, {
    method: 'PATCH',
    headers: {
      'X-API-Key': API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      type: 'product',
      adjustment,
    }),
  });
  
  return response.json();
}
Python
import requests

API_KEY = 'qs_live_xxxx'
BASE_URL = 'https://my-quickshop.com/api/v1'
HEADERS = {'X-API-Key': API_KEY}

def get_orders(page=1, limit=50):
    response = requests.get(
        f'{BASE_URL}/orders',
        headers=HEADERS,
        params={'page': page, 'limit': limit}
    )
    return response.json()['data']

def update_order_status(order_id, status):
    response = requests.patch(
        f'{BASE_URL}/orders/{order_id}',
        headers=HEADERS,
        json={'status': status}
    )
    return response.json()

פורמט Response

Success Response
{
  "data": [
    {
      "id": "uuid",
      "order_number": "1001",
      "status": "processing",
      "total": 480.00,
      "created_at": "2026-01-06T10:00:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 150,
      "total_pages": 3,
      "has_next": true,
      "has_prev": false
    }
  }
}
Error Response
{
  "error": {
    "code": "not_found",
    "message": "Order not found"
  }
}

מוכנים להתחיל?

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