הגדרת קובץ PDF בסיס מותאם אישית באמצעות API

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

מתי להשתמש ב-Custom Base PDF באמצעות API?

השימוש ב-Custom Base PDF הוא אידיאלי כאשר יש צורך לשמור על מבנה שדות עקבי (למשל, תיבות חתימה, שדות תאריך במיקומים קבועים) על פני מסמכים עם תוכן בסיס שונה. הנה כמה מקרי שימוש נפוצים:

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

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

שילוב עם תגיות דינאמיות ב-PDF

תכונה זו שימושית במיוחד בשילוב עם זיהוי אוטומטי של תגיות דינאמיות ב-PDF.

ניתן ליצור מסמך PDF דינמי לחלוטין הכולל תגיות דינאמיות (למשל, {signature}, {date_today}, {name}). כאשר שולחים PDF זה כ-Custom Base PDF, מערכת FillFaster תזהה באופן אוטומטי את התגיות הללו ותמיר אותן לשדות אינטראקטיביים למילוי על ידי הנמען.

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

דוגמת בקשת API

כדי להגדיר Custom Base PDF, יש לכלול את האובייקט formData עם המאפיין basePdf בבקשת יצירת ההגשה.

{
    "fid": "sfRPPph",
    "prefill_data": {
        "name": "John Smith"
    },
    "user_data": {
        "uid": 123
    },
    "formData": {
        "formName": "Custom Title for John Smith",
        "basePdf": "data:application/pdf;base64,JVBERi0xLjcKJeLjz9MKO..."
    }
}

פרמטרים מרכזיים

• fid: מזהה תבנית הטופס שלך. ניתן למצוא אותו בכתובת ה-URL של הטופס.
• prefill_data: אובייקט המכיל נתונים למילוי מראש בשדות הטופס.
• user_data: אופציונלי. מטא-דאטה שתישלח בחזרה ב-webhooks.
• formData: אופציונלי. אובייקט לדריסת הגדרות הטופס.
  • formName: אופציונלי. שם חדש להגשה הספציפית הזו.
  • basePdf: מסמך ה-PDF המותאם אישית. חובה לשלוח כמחרוזת בקידוד Base64, עם הקידומת data:application/pdf;base64,.