יכולות ה-API

כל מה שאתם צריכים כדי לשלב פקס במערכות שלכם

שליחת פקס

שלחו פקסים באופן תכנותי. העלו מסמך, הגדירו מספר נמען ושלחו. תמיכה בשליחה יחידה ובשליחה מרובה (batch).

קבלת פקס

קבלו התראות על פקסים נכנסים באמצעות Webhooks. הורידו את הפקסים כקבצי PDF באופן אוטומטי.

מעקב סטטוס

עקבו אחרי סטטוס כל פקס בזמן אמת. קבלו עדכונים על הצלחה, כישלון, ניסיונות חוזרים ועוד.

Webhooks

קבלו התראות HTTP אוטומטיות לכל אירוע: פקס נשלח, פקס התקבל, שגיאה ועוד. בזמן אמת.

אימות מאובטח

אימות באמצעות API Key או OAuth 2.0. כל הבקשות מועברות בהצפנת TLS מלאה.

תיעוד מלא

תיעוד מקיף עם דוגמאות קוד בשפות מרובות, מדריכים מפורטים וסביבת Sandbox לבדיקות.

נקודות קצה עיקריות

סקירה של ה-Endpoints המרכזיים ב-API

POST /api/v1/fax/send

שליחת פקס חדש. העלו מסמך והגדירו מספר נמען.

GET /api/v1/fax/{id}/status

בדיקת סטטוס של פקס שנשלח. מחזיר סטטוס, זמן שליחה ופרטי מסירה.

GET /api/v1/fax/inbox

רשימת הפקסים הנכנסים. כולל פילטור לפי תאריך, שולח וסטטוס.

GET /api/v1/fax/{id}/download

הורדת פקס נכנס כקובץ PDF.

POST /api/v1/webhooks

הגדרת Webhook לקבלת התראות על אירועים (פקס נשלח, התקבל, שגיאה).

דוגמאות קוד

שלבו את SendFax API בשפת התכנות המועדפת עליכם

cURL

# Send a fax via API
curl -X POST https://api.sendfax.co.il/v1/fax/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "to=0312345678" \
  -F "file=@document.pdf"

Python

import requests

url = "https://api.sendfax.co.il/v1/fax/send"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

with open("document.pdf", "rb") as f:
    files = {"file": f}
    data = {"to": "0312345678"}
    response = requests.post(url, headers=headers,
                              files=files, data=data)

print(response.json())
# {"id": "fax_abc123", "status": "queued"}

Node.js

const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');

const form = new FormData();
form.append('to', '0312345678');
form.append('file', fs.createReadStream('document.pdf'));

const response = await axios.post(
  'https://api.sendfax.co.il/v1/fax/send',
  form,
  {
    headers: {
      ...form.getHeaders(),
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

console.log(response.data);
// { id: 'fax_abc123', status: 'queued' }

API פקס - המדריך המלא למפתחים

API הפקס של SendFax מאפשר למפתחים לשלב שליחת וקבלת פקסים בכל מערכת תוכנה. בין אם אתם בונים מערכת CRM, מערכת ניהול מסמכים, אפליקציה עסקית או כל מערכת אחרת שדורשת יכולת שליחת פקסים - ה-API שלנו מספק את כל הכלים הדרושים.

ה-API בנוי על ארכיטקטורת REST סטנדרטית, עם תגובות JSON ברורות, קודי שגיאה מפורטים ותיעוד מקיף. המערכת תומכת באימות באמצעות API Key או OAuth 2.0, וכל התקשורת מוצפנת ב-TLS.

שליחת פקס באמצעות API

שליחת פקס דרך ה-API היא תהליך פשוט וישיר. שלחו בקשת POST לנקודת הקצה /api/v1/fax/send עם הפרמטרים הבאים: מספר הפקס של הנמען (to), הקובץ לשליחה (file) ופרמטרים אופציונליים נוספים כמו עמוד שער (cover page) ותזמון שליחה (schedule).

ה-API תומך בשליחת קבצי PDF, Word, Excel, PowerPoint ותמונות. המערכת ממירה אוטומטית כל פורמט נתמך לפקס תקני. ניתן גם לשלוח מספר קבצים בבקשה אחת - הם ימוזגו לפקס אחד.

קבלת פקסים עם Webhooks

אחת היכולות החשובות ביותר של ה-API היא מנגנון ה-Webhooks. כאשר מגדירים Webhook, המערכת שולחת התראת HTTP (POST) לכתובת URL שתגדירו בכל פעם שמתרחש אירוע. האירועים כוללים:

fax.received - פקס חדש התקבל. כולל את מספר השולח, מספר העמודים וקישור להורדת ה-PDF.
fax.sent - פקס שנשלח הגיע ליעדו בהצלחה. כולל פרטי מסירה מלאים.
fax.failed - שליחת פקס נכשלה. כולל קוד שגיאה ותיאור הבעיה.
fax.retrying - המערכת מנסה שוב לשלוח פקס שלא הצליח (למשל, קו תפוס).

אימות ואבטחה

ה-API של SendFax תומך בשתי שיטות אימות. הדרך הפשוטה ביותר היא שימוש ב-API Key שנשלח בכותרת Authorization של כל בקשה. לפרויקטים מורכבים יותר, המערכת תומכת גם ב-OAuth 2.0 לניהול הרשאות מפורט יותר.

כל הבקשות ל-API חייבות להיות מוצפנות ב-HTTPS. בקשות HTTP לא מוצפנות יידחו. בנוסף, כל Webhook נשלח עם חתימה דיגיטלית (signature) שמאפשרת לכם לוודא שההתראה אכן הגיעה מ-SendFax ולא מגורם זדוני.

Rate Limits

ה-API כולל מגבלות קצב (Rate Limits) להבטחת ביצועים אופטימליים לכל המשתמשים. ברירת המחדל היא 60 בקשות לדקה, אך ניתן להגדיל את המגבלה בתוכניות עסקיות. כל תגובת API כוללת כותרות שמצביעות על מספר הבקשות הנותרות וזמן האיפוס.

סביבת בדיקות (Sandbox)

SendFax מספקת סביבת Sandbox מלאה לבדיקות ופיתוח. בסביבת ה-Sandbox, תוכלו לבדוק את כל הפונקציות של ה-API ללא עלות וללא שליחת פקסים אמיתיים. הסביבה מדמה את כל ההתנהגויות של הסביבה הייצורית, כולל תגובות הצלחה, שגיאות ו-Webhooks.

שילובים נפוצים

ה-API של SendFax משתלב בקלות עם מערכות קיימות. לקוחות משתמשים ב-API לשילוב פקס במערכות CRM כמו Salesforce ו-HubSpot, במערכות ERP, במערכות ניהול מסמכים ובאפליקציות מותאמות אישית. השילוב פשוט ומהיר - ברוב המקרים, ניתן להוסיף יכולת שליחת פקס למערכת קיימת תוך מספר שעות בלבד.

אנחנו מציעים גם ספריות קוד מוכנות (SDK) לשפות התכנות הפופולריות ביותר, כולל Python, Node.js, PHP, Java ו-C#. הספריות מפשטות את העבודה עם ה-API ומספקות פונקציות נוחות לכל הפעולות הנפוצות.

API פקס למפתחים