API לקבלת פרטי מסמך בודד

שימוש ב API לקבלת פרטים על מסמך במערכת חשבונית ירוקה

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

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

 

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

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

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

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

{
	"timestamp": 1380095506, //זמן נוכחי בשניות
	"id" => "73fb577c-e210-4d24-8150-0a0c8a5699fd" //מזהה ייחודי של המסמך      
}

 

את אובייקט הנתונים, שנקרא לו לצורך הענין בשם 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/get?" . $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": 1405543716,
  "processing_time_ms": 9.892,
  "data": {
    "document": {
      "id": "73fb577c-e210-4d24-8150-0a0c8a5699fd",
      "document_id": 100226,
      "doc_type": 300,
      "date": "2014-07-07",
      "description": "",
      "currency": "ILS",
      "currency_rate": 1,
      "lang": "en",
      "amount": 37.76,
      "amount_due_vat": 32,
      "amount_exempt_vat": 0,
      "vat": 5.76,
      "status": 0,
      "client": {
        "name": "שם לקוח"
      },
      "url": {
        "he": "https://www.greeninvoice.co.il/invoices/show?d={HE_LINK}",
        "en": "https://www.greeninvoice.co.il/invoices/show?d={EN_LINK}"
      }
    }
  }
}

 

תיעוד נתוני המסמך שמוחזר

שם שדההערות
idמזהה ייחודי של המסמך במערכת חשבונית ירוקה
document_idמספר סידורי של המסמך
doc_typeסוג מסמך
dateתאריך המסמך
descriptionתיאור המסמך
currencyמטבע
currency_rateשער המרה של המטבע (1 במקרה של שקל)
langשפת המסמך (he - עברית, en - אנגלית)
amountסכום המסמך (כולל מע״מ אם קיים)
amount_due_vatסכום חייב במע״מ
amount_exempt_vatסכום פטור ממע״מ
vatסה״כ מע״מ
statusסטטוס מסמך
clientפרטים על הלקוח, שם, מספר עוסק מורשה וכד׳
urlקישור להורדת העתק נאמן למקור של המסמך (he - עברית, en - אנגלית)

 

המשך קריאה:

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

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