מרכז הידע / ממשקים API

שאלו את ה-AI

✦ תשובת ה-AI

חושב…

מקורות

    יצירת URL למסמך - (Create document URL)

    מתי להשתמש בפונקציה זו?

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

    הפונקציה מאפשרת ללקוחות לגשת למסמכים המשויכים אליהם כאשר הם נכנסים לכרטיס הלקוח שלהם בממשק החיצוני.

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

    בנוסף, הפונקציה עשויה להיות שימושית גם כאשר בית העסק עצמו רוצה לגשת ולראות את המסמכים המשויכים ללקוח.

    להלן קישור לפונקציה בJSON.

    שיטת בקשה - POST.
    Create document URL

    https://secure.cardcom.solutions/api/v11/Documents/CreateDocumentUrl

    להלן הפרמטרים שצרים להעביר בפונקציה Create document URL.

    מקרא:

    פרמטר אדום - חובה

    פרמטר מודגש - מומלץ

    פרמטר לא אדום ולא מודגש - אופציונלי

    מספר פרמטר ערכים אפשריים לדוגמא תיאור
    1 ApiName "test2025" שם משתמש ממשקים. יש לקבל פרמטר זה מבית העסק. 
    2 ApiPassword "kzFKfohEvL6AOF8aMEJz" סיסמת API, מיועד לזיכוי וביטול עסקאות.
    3 DocumentType

    "TaxInvoiceAndReceipt" – חשבונית מס וקבלה

    "TaxInvoiceAndReceiptRefund" – חשבונית זיכוי והחזר כספים

    "Receipt" – קבלה מלכ''ר

    "ReceiptRefund" – קבלה מלכ"ר זיכוי ( החזר כספים)

    "Quote" – הצעת מחיר

    "Order" – הזמנה

    "OrderConfirmation" – אישור הזמנה - מאתר

    "OrderConfirmationRefund" – זיכוי אישור הזמנה - מאתר

    "DeliveryNote" – תעודת משלוח

    "DeliveryNoteRefund" – תעודת החזרה

    "ProformaInvoice" – חשבון עסקה

    "DemandForPayment" – דרישה לתשלום

    "DemandForPaymentRefund" – ביטול דרישה לתשלום

    "ProformaDealInvoice" – חשבון קבלה פרופורמה

    "ProformaDealInvoiceRefund" –חשבון קבלה זיכוי

    "TaxInvoice" – חשבונית מס

    "ProformaInvoiceRefund" – זיכוי חשבון עסקה

    "TaxInvoiceRefund" – חשבונית מס זיכוי

    "ReceiptForTaxInvoice" – קבלה (לחשבונית)

    "DonationReceipt" – קבלה על תרומה

    "DonationReceiptRefund" – זיכוי קבלה תרומה (החזר כספים)

    "ReceiptForTaxInvoiceRefund" – החזר כספים לקוחות (קבלה זיכוי) 

    		 סוג מסמך של המספר מסמך.
    4 DocumentNumber 5176 מספר מסמך.

     

     RESPONSE של Create document URL.

    מספר פרמטר ערכים אפשריים לדוגמא תיאור
    1 ResponseCode 0 קוד תשובה, אם שווה לאפס הפונקציה בוצעה בצורה תקינה. בכל תשובה אחרת, הפעולה לא הייתה תקינה.
    2 Description "OK" תיאור התשובה. ''OK'' זה טוב.
    3 DocUrl " https://tinyurl.com/2bsyebdh " הקישור למסמך.

     

    להלן קוד לדוגמא לפונקציה ביחד עם התשובה.

    דוגמא לקריאה ליצירת הקישור למסך:

    {
      "ApiName": "test2025",
      "ApiPassword": "test5000$",
      "DocumentType": "TaxInvoiceAndReceipt",
      "DocumentNumber": "586436"
    }

    דוגמא לתשובה המתקבלת:

    {
        "ResponseCode": 0,
        "Description": "The URL was created successfully",
        "DocUrl": " https://tinyurl.com/2bsyebdh "
    }

     

    האם המאמר הזה עזר לך?