API לחיפוש מסמכים

חיפוש מסמכים באמצעות ממשק API במערכת חשבונית ירוקה

המדריך הבא מציג הנחיות לממשק ה- API הישן. לממשק ה- API החדש שלנו, לחצו כאן.

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

 

תיאור כללי של תהליך חיפוש מסמכים

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

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

שימו לב כי המערכת מחזירה לכל היותר 100 מסמכים בכל חיפוש!

זהו מבנה נתונים לדוגמא שעליכם לשלוח בבקשה לחיפוש מסמכים:

{
	"timestamp": 1380095506, //זמן נוכחי בשניות
	"from_date": "2015-12-31",
	"to_date": "2016-12-31",
	"doc_type" => 300 //סוג המסמך      
}

 

את אובייקט הנתונים, שנקרא לו לצורך הענין בשם params, יש לחתום באופן הבא (דוגמא ב php):

	$params_encoded = json_encode($params);
	$signature = base64_encode(hash_hmac('sha256', $params_encoded), "{api_secret}", true));

 

לאחר מכן, יש לשלוח את החתימה ואת המפתח הציבורי שלכם למערכת ה API (דוגמא ב php):

$data = array(
	"apiKey" => $apiKey,
	"params" => $params,
	"sig" => $signature
);

//Initializing curl
$ch = curl_init();

//Configuring curl options
$query = "data=" . urlencode(json_encode($data));
$options = array(
	CURLOPT_URL => "https://www.greeninvoice.co.il/api/documents/search?" . $query,
	CURLOPT_HTTPHEADER => array('Content-type: application/json'),
	CURLOPT_RETURNTRANSFER => true
);

//Setting curl options
curl_setopt_array($ch, $options);

//Getting results
$result = curl_exec($ch); // Getting jSON result string
curl_close($ch);

 

התשובה שמתקבלת תכיל את פרטי המסמכים, בתוך שדה data:

{
  "error_code": 0,
  "error_description": "OK",
  "timestamp": 1405584369,
  "processing_time_ms": 8.497,
  "data": {
    "documents": [            
      {
        "id": "38b43a49-10e4-8164-69db-6774e0440fc5",
        "document_id": 100223,
        "type": 300,
        "date": "2014-04-30",
        "description": "",
        "currency": "ILS",
        "currencyRate": 1,
        "lang": "he",
        "amount": 37.76,
        "amount_due_vat": 32,
        "amount_exempt_vat": 0,
        "vat": 5.76,
        "vat_type": 0,
        "status": 0,
        "client": {
          "name": "שם לקוח",
          "id": "00008c49-5855-96d4-b13b-4dcca032b200",
          "taxId": "123456789"
        },
        "url": {
          "he": "https:\/\/www.greeninvoice.co.il\/app\/documents\/pdf?d={HE_LINK}"
        }
      }
    ],
    "total": 1,
    "size": 1
  }
}

 

שם שדההערות
document_idמספר סידורי של המסמך
doc_typeסוג מסמך
from_dateמסמכים שהופקו עם תאריך ערך גדול או שווה לערך זה
to_dateמסמכים שהופקו עם תאריך ערך קטן או שווה לערך זה
client_idמזהה ייחודי של הלקוח במערכת חשבונית ירוקה
client_nameשם הלקוח

 

תיעוד תוצאות החיפוש

שם שדההערות
documentsמערך המכיל את המסמכים שנמצאו בחיפוש שהוגדר. לפירוט תיעוד מסמך לחצו כאן.
totalסה״כ מסמכים שנמצאו שמתאימים לחיפוש שהוגדר
sizeסה״כ מסמכים שנמצאו שמתאימים לחיפוש שהוגדר ומוצגים בבקשה זו (עד 100)

 

המשך קריאה:

עדיין זקוקים לעזרה?

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