ה-API של Quickly. כל מה שיש בדשבורד, גם מהקוד.

התחלה מהירה

3 שלבים — מהפעלה ועד חשבונית ראשונה.

curl https://www.quicklyinv.co.il/api/v1/invoices \
  -H "Authorization: Bearer qkly_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "<UUID של הלקוח>",
    "items": [
      { "description": "ייעוץ", "quantity": 1, "unit_price": 500, "total": 500, "vat_rate": 17 }
    ],
    "type": "invoice"
  }'

אימות והרשאות

כל מפתח שייך לעסק יחיד ונשמר כ-SHA-256 hash. ניתן לבטל מפתח בכל רגע מהדשבורד; קריאות עם מפתח מבוטל מקבלות 401 מיידי.

קטלוג Endpoints

כל הקריאות תחת https://www.quicklyinv.co.il ומחזירות JSON בפורמט { success, data | error }.

דוגמאות נוספות

סריקת קבלה עם תמונה

curl https://www.quicklyinv.co.il/api/v1/expenses/scan?commit=true \
  -H "Authorization: Bearer qkly_live_..." \
  -F "file=@receipt.jpg"

סימון חשבונית כשולמה והפקת קבלה

curl -X POST https://www.quicklyinv.co.il/api/v1/invoices/{id}/mark-paid \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "payment_method": "credit_card" }'

המרת הצעה לחשבונית מס/קבלה

curl -X POST https://www.quicklyinv.co.il/api/v1/quotes/{id}/convert \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "receipt", "payment_method": "bit" }'

דוח מע״מ דו-חודשי

curl "https://www.quicklyinv.co.il/api/v1/reports/vat?from=2026-05-01&to=2026-06-30" \
  -H "Authorization: Bearer qkly_live_..."

בדיקת חיים מהירה (Ping)

curl https://www.quicklyinv.co.il/api/v1/ping \
  -H "Authorization: Bearer qkly_live_..."

# התשובה כוללת את ה-scopes שניתנו למפתח — שימושי לאימות מהיר של ההגדרה.

רישום webhook ואימות חתימה

# 1) רישום endpoint — תקבל את ה-secret פעם אחת
curl -X POST https://www.quicklyinv.co.il/api/v1/webhooks \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.example.co/quickly-events",
    "events": ["invoice.paid", "invoice.created"],
    "description": "Make.com integration"
  }'

# התשובה: { ..., "secret": "whsec_..." }   // שמור!

2) בצד המקבל — אימות החתימה ב-Node.js:

import crypto from "crypto";

function verify(secret, header, rawBody) {
  const m = Object.fromEntries(header.split(",").map(p => p.split("=")));
  const expected = crypto.createHmac("sha256", secret)
    .update(`${m.t}.${rawBody}`).digest("hex");
  return expected === m.v1 && Math.abs(Date.now()/1000 - +m.t) < 300;
}

// app.post("/quickly-events", (req, res) => {
//   const ok = verify(SECRET, req.headers["x-quickly-signature"], rawBody);
//   if (!ok) return res.status(401).end();
//   const { event, data } = JSON.parse(rawBody);
//   // ... handle event
//   res.status(200).end();
// });

OpenAPI Spec

ה-spec הרשמי בפורמט OpenAPI 3.0 זמין בכתובת:

https://www.quicklyinv.co.il/api/v1/openapi.json

• · ChatGPT Custom GPT — ב-GPT Builder תחת Actions → Schema → Import from URL, הדבק את הכתובת.
• · Postman / Insomnia — File → Import → Link.
• · SDK generation — openapi-generator-cli generate -i https://www.quicklyinv.co.il/api/v1/openapi.json -g typescript-fetch -o ./quickly-sdk

חיבור לעוזרי AI

אותו מפתח עובד גם מול MCP (Claude Desktop) וגם מול ChatGPT Custom GPT (OAuth).

Claude Desktop · MCP

הוסף את הקטע הבא ל-claude_desktop_config.json:

{
  "mcpServers": {
    "quickly": {
      "command": "npx",
      "args": ["-y", "@quickly/mcp-server"],
      "env": {
        "QUICKLY_API_KEY": "qkly_live_..."
      }
    }
  }
}

ChatGPT · Custom GPT

ב-GPT Builder, תחת Actions → Authentication → OAuth, השתמש בערכים הבאים:

• · Authorization URL: https://www.quicklyinv.co.il/api/oauth/authorize
• · Token URL: https://www.quicklyinv.co.il/api/oauth/token
• · Scope: read write
• · OpenAPI Schema URL: https://www.quicklyinv.co.il/api/v1/openapi.json

בניית Connector משלך

אם אתה בונה אפליקציה (CRM, ERP, אוטומציה) ורוצה שמשתמשים שלך יחברו את החשבון שלהם ב-Quickly דרך OAuth — בדומה ל-Make.com — זה הזרימה.

1. רשום את האפליקציה שלך ב- /dashboard/developers תחת "אפליקציות שלי (OAuth)". תקבל client_id ו-client_secret (שמור — לא יוצג שוב).
2. שלח את המשתמש שלך ל-URL הזה (החלף את הפרמטרים):

   https://www.quicklyinv.co.il/api/oauth/authorize
     ?client_id=app_...
     &redirect_uri=https://your-app.com/oauth/callback
     &response_type=code
     &state=<random-csrf-token>
     &scope=read+write+reports

3. המשתמש מאמת OTP מול Quickly, מאשר את הסקופים, וחוזר אליך עם:?code=...&state=...
4. החלף את ה-code בtoken מהשרת שלך:

   curl -X POST https://www.quicklyinv.co.il/api/oauth/token \
     -d "grant_type=authorization_code" \
     -d "code=<from-redirect>" \
     -d "redirect_uri=https://your-app.com/oauth/callback" \
     -d "client_id=app_..." \
     -d "client_secret=secret_..."
   
   # תשובה: { access_token, refresh_token, expires_in, scope }

5. השתמש ב-access_token כ-Bearer בכל קריאה ל-/api/v1/*. רענן עם:

   curl -X POST https://www.quicklyinv.co.il/api/oauth/token \
     -d "grant_type=refresh_token" \
     -d "refresh_token=..." \
     -d "client_id=app_..." \
     -d "client_secret=secret_..."