קריאה ראשונה ב-REST

הבקשה, התשובה, והשגיאות של ה-REST API.

כל פעולה היא בקשת POST לכתובת https://api.askpay.co/v1/<שם הפעולה> עם גוף JSON, וכותרת Authorization: Bearer ask_…. כל הפעולות, עם השדות שלהן ואפשרות לנסות, בתיעוד ה-Swagger: https://api.askpay.co/docs.

דוגמה: התשלומים שמוכנים לתשלום

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": [
      {
        "id": "k3Yq…",
        "status": "ready",
        "supplierName": "שטיימץ עמינוח",
        "amountAgorot": 350000,
        "currency": "ILS",
        "invoice": { "fileName": "inv-1042.pdf", "url": "https://files.askpay.co/…/inv-1042.pdf" },
        "link": "https://askpay.co/p/k3Yq…"
      }
    ],
    "total": 1, "limit": 20, "offset": 0
  }
}

דוגמה: יצירת תשלום לספק

curl -X POST https://api.askpay.co/v1/createPayment \
  -H "Authorization: Bearer ask_…" \
  -H "Content-Type: application/json" \
  -d '{
    "supplierName": "דנה עיצוב",
    "supplierPhone": "0521234567",
    "amountAgorot": 120000,
    "vatIncluded": true,
    "description": "עיצוב דף נחיתה, אוגוסט"
  }'

הספק מקבל את הלינק בוואטסאפ (או במייל כששולחים supplierEmail). כדי לא לשלוח כלום ולמסור את הלינק בעצמכם, מוסיפים "channel": "link".

GET לפעולות קריאה

פעולות שרק קוראות (רשימות, whoami, getBusiness) מקבלות גם GET, עם השדות ב-query string:

GET https://api.askpay.co/v1/invoicesList?category=software&limit=50

שגיאות

תשובת שגיאה תמיד באותו מבנה, עם קוד HTTP תואם:

{ "ok": false, "error": { "code": "invalid-argument", "message": "missing required field \"amountAgorot\"" } }

הכתובת הישירה של הפונקציה, בלי ה-CDN באמצע, היא https://us-central1-askpay.cloudfunctions.net/api/v1/<פעולה>. שימושית לפעולות ארוכות כמו accZip או statementsZip.

עדיין תקועים? כתבו לנו ונענה מהר.