API לסגירת מסמך

סגירת מסמך פתוח באמצעות ממשק ה API

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

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

 

תיאור כללי של תהליך סגירת מסמך בודד

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

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

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

{
	"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
$options = array(
    CURLOPT_URL => "https://www.greeninvoice.co.il/api/documents/close",
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => "data=" . urlencode(jsonEncode($data)),
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_SSL_VERIFYPEER => false,
    CURLOPT_SSL_VERIFYHOST => false,
    CURLOPT_VERBOSE => true
);

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

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

 

התשובה שמתקבלת במידה והמסמך היה בסטטוס פתוח:

{
  "error_code": 0,
  "error_description": "OK",
  "timestamp": 1405543716,
  "processing_time_ms": 9.892,
  "data": {
  }
}

 

המשך קריאה:

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

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