AskPay למפתחים: API ו-MCP
כל מה שאפשר לעשות בדשבורד של AskPay אפשר לעשות גם מקוד, וגם מ-Claude. מפתח אחד, REST API עם 129 פעולות, ושרת MCP שמחבר את Claude Code ו-Claude Desktop ישירות לחשבון שלכם.
1. מפתח API
נכנסים לדשבורד, הגדרות, ואז לטאב API ו-Claude. נותנים למפתח שם (למשל "Claude של דנה") ולוחצים "צור מפתח". המפתח מתחיל ב-ask_ ומוצג פעם אחת בלבד, אז שומרים אותו במקום בטוח.
- המפתח פועל בשם המשתמש שיצר אותו, עם אותו תפקיד (מנהל או משתמש). רק מנהל יכול ליצור מפתחות.
- אפשר לבטל מפתח בכל רגע. מי שהוסר מהצוות מאבד גם את המפתחות שלו באותו רגע.
- עד 20 מפתחות פעילים לעסק. כל קריאה דרך מפתח נרשמת ביומן הפעילות כ-"API · שם המפתח".
2. REST: קריאה ראשונה
כל פעולה היא בקשת POST ל-https://api.askpay.co/v1/<שם הפעולה> עם גוף JSON, וכותרת Authorization: Bearer ask_…. פעולות קריאה בלבד מקבלות גם GET עם השדות ב-query string.
curl -X POST https://api.askpay.co/v1/paymentsList \
-H "Authorization: Bearer ask_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"status":"ready","limit":20}'
תשובה מוצלחת:
{ "ok": true, "result": { "items": [ … ], "total": 3, "limit": 20, "offset": 0 } }
שגיאה, עם קוד HTTP תואם:
{ "ok": false, "error": { "code": "invalid-argument", "message": "missing required field \"amountAgorot\"" } }
| קוד | HTTP | מתי |
|---|---|---|
unauthenticated | 401 | אין מפתח, מפתח לא תקין או מבוטל |
permission-denied | 403 | הפעולה דורשת מנהל, או שהחברות בצוות הוסרה |
invalid-argument | 400 | שדה חסר או בטיפוס לא נכון |
not-found | 404 | מזהה שלא קיים, או פעולה שלא קיימת |
resource-exhausted | 429 | מכסה יומית (למשל של AI) נגמרה |
3. חיבור Claude דרך MCP
שרת ה-MCP יושב ב-https://mcp.askpay.co (Streamable HTTP) ומזדהה עם אותו מפתח. כל פעולה בקטלוג היא כלי; פעולות הרסניות (מחיקה, ביטול, ניתוק) מסומנות כך ש-Claude יאשר איתכם לפני.
Claude Code
claude mcp add --transport http askpay https://mcp.askpay.co \
--header "Authorization: Bearer ask_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Claude Desktop
בקובץ claude_desktop_config.json (הגדרות, Developer, Edit Config), ואז הפעלה מחדש של Claude Desktop:
{
"mcpServers": {
"askpay": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.askpay.co", "--header", "Authorization:${AUTH_HEADER}"],
"env": { "AUTH_HEADER": "Bearer ask_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
}
}
}
ואז פשוט מבקשים: "תראה לי את התשלומים שמוכנים לתשלום", "תעלה את החשבונית הזאת ותסווג אותה", "תכין ZIP לרואה החשבון של יולי". Claude מתחיל תמיד ב-whoami כדי לדעת בשם איזה עסק הוא עובד.
4. מוסכמות
- סכומים הם מספרים שלמים באגורות (1 ₪ = 100 אגורות; סנטים עבור USD ו-EUR). מטבעות: ILS, USD, EUR.
- מזהים:
paymentIdלתשלום,docIdלחשבונית שהועלתה,supplierKeyלספק (טלפון בפורמט E.164 או אימייל),folderIdלתיקייה,accountIdלחשבון דפי פירוט או תיבת Gmail. - תאריכים חוזרים כמחרוזות ISO. חודשים של דפי פירוט הם
YYYY-MM. - קבצים חוזרים כקישורים ב-
files.askpay.co. מי שמחזיק את הקישור יכול לפתוח את הקובץ, כמו לינק תשלום. - העלאות (חשבונית, הוכחת תשלום, טופס) נשלחות כ-
fileName,mimeTypeו-dataBase64. - דפדוף ברשימות:
limit(עד 200) ו-offset.
5. מה יש בקטלוג
| קבוצה | פעולות עיקריות |
|---|---|
| חשבון | whoami, getBusiness, updateBusiness, setBusinessApp, הלינק הקבוע, אינטגרציות, רשות המסים |
| תשלום לספקים | paymentsList, paymentGet, createPayment, updatePaymentSettings, resendPayment, markPaid, revertPaid, cancelPayment |
| תשלומים לקבל | listIncomingPayments |
| ספקים | suppliersList, getSupplierContact, saveSupplierContact, createSupplier, הצעות ספקים |
| חשבוניות | invoicesList, invoiceGet, uploadInvoiceDoc, analyzeInvoice, updateInvoiceDoc, סימוני תשלום, סיווג הוצאות, מיילים |
| תיקיות | foldersList, יצירה, שינוי שם, העברה, מחיקה, חוקים לתיקיות |
| תוכנות | softwareList, softwareSync, softwareUpdate |
| דפי פירוט | statementsList, statementsZip, statementsSend, חיבור ומשיכה ל-Stripe, Mercury, Wise, BlueSnap, Upwork |
| Gmail ואוטומציות | תיבות, תוויות, ייבוא, אוטומציות והריצות שלהן |
| עובדים ומשתמשים | employeesList, Slack, listTeam, inviteMember, תפקידים |
| מסמכים ורואה חשבון | טפסי פתיחת ספק, תיקיות רואה חשבון, accZip |
| יומן פעילות | listActivity |
הרשימה המלאה, עם התיאור והשדות של כל פעולה, נמצאת בקטלוג החי: api.askpay.co/v1. לא נמצאות ב-API: כניסה וקודי אימות, עמודי הלינק של הספק (הם עובדים עם הלינק עצמו, בלי חשבון), כלי ניהול, ומחיקת חשבון.
אבטחה
- מפתח API שווה לסשן של המשתמש. שומרים אותו כמו סיסמה, לא מכניסים אותו לקוד שמתפרסם, ומבטלים מפתח שדלף בלחיצה אחת.
- כל התעבורה ב-HTTPS. המפתחות נשמרים אצלנו כ-hash בלבד, אף אחד לא יכול לקרוא אותם חזרה.
- קריאות שמשנות משהו נרשמות ביומן הפעילות של העסק עם שם המפתח, כך שתמיד רואים מי עשה מה.
שאלה או בקשה לפעולה שחסרה?
כתבו לנו: info@askpay.co