מבוא להתחברות לממשק ה API של מערכת חשבונית ירוקה
התחלת שימוש בממשק ה- API
המדריך הבא מציג הנחיות לממשק ה- API הישן. לממשק ה- API החדש שלנו, לחצו כאן.
שימו לב: גישה לממשק ה-API קיימת רק החל ממסלול ה- Popular והלאה. למסלולי המנויים לחצו כאן.
במדריך זה נסביר כיצד מתחברים לממשק ה API של מערכת חשבונית ירוקה, כדי להפיק או לצפות במסמכים באמצעות גישה מרחוק, שלא באמצעות גלישה באתר. בין השימושים האפשריים למערכת ה API ניתן למצוא:
- הפקת חשבוניות מס וקבלות באופן אוטומטי ללקוח לאחר ביצוע רכישה בכרטיס אשראי באתר אינטרנט.
- התחברות ממערכות CRM חיצוניות.
שלב 1: הרשמה לאתר ויצירת מפתחות API
זיהוי ואימות משתמש ה API מתבצע באמצעות שימוש במפתח ציבורי ופרטי (הצפנה א-סימטרית). לקריאה נוספת על מפתח ציבורי לחצו כאן.
בכדי להתחיל להשתמש ב API עליכם להיות רשומים למערכת חשבונית ירוקה ולהקים עסק פעיל. אם עדיין לא נרשמתם לאתר תוכלו להתחיל כעת:
לאחר שנרשמתם לאתר והקמתם עסק, עליכם ליצור זוג מפתחות API חדש, עם ההרשאות המתאימות לסוג ה API שבו ברצונכם להשתמש. שימו לב כי המפתחות נוצרים כברירת מחדל במצב לא פעיל. לאחר שהשלמתם את תהליך הפיתוח, או בכל עת שתחפצו, תוכלו להעביר את מפתח ה API למצב פעיל שיאפשר הפקת חשבוניות אוטומטיות.
שלב 2: שליחת נתונים עם חתימה ל API
לאחר שיצרתם מפתחות תקינים, עליכם לכתוב את הקוד הרלבנטי שפונה למערכת חשבונית ירוקה עם מפתחות ה API הרלבנטים. סוג התוכן (Content-Type) איתו אנחנו עובדים הוא בפורמט JSON.
כל בקשה צריכה להיחתם באמצעות שימוש בפונקציית חתימה עם המפתח הפרטי שלכם ואלגוריתם SHA-256. כמעט בכל שפות הפיתוח הקיימות קיימת פונקציה מובנית כזו. חתימת הבקשה עם המפתח האישי שלכם תאפשר רק לכם ליצור בקשות ותמנע מגורם חיצוני לעשות בקשות כאלו בשמכם.
למעשה אתם חותמים את אובייקט params שנשלח ומצרפים את החתימה לנתונים. אנחנו נבצע חתימה בצד שלנו ונשווה בין החתימות וכך נוודא את זהותכם.
תוכלו לכתוב את הקוד בכל שפה שתבחרו תוך שמירה על מבנה הנתונים הנדרש ופניה באמצעות בקשת HTTP סטדנרטית (POST או GET בהתאם לסוג ה API).
מערכת חשבונית ירוקה תומכת בממשקי ה API הבאים:
