API

הנחיות לשימוש בAPI של אדוונסקרין 

להלן עקרונות הארכיטקטורה להתחברות רציפה לAPI :

לביצוע סריקה, המערכת שלכם תבצע פנייה וובית לשרת שלנו בפורמט הבא:

https://[email protected]&password=xxx&search=first$middle$last

 הפרמטרים לשרשור ב string הנ״ל הם:

  • OURLINK – ימסר בהודעה נפרדת
  • User  שם המשתמש שלכם באדוונסקרין
  • Password הסיסמא שסופקה לכם ברישום
  • Search  יש לשרשר את חלקי שם הנסרק עם סימני $ ביניהם, הסדר אינו משנה. מקף בתוך שם (בן-יוסף) נחשב לאות.

התשובה חוזרת כטבלת JSON בה כל שורה מייצגת רשימה שנסרקה לצד הערך false (אין התאמה)  או true (התאמה פוטנציאלית). הנה דוגמא להמחשה:

ListName: Israel  A, ReturnValue: false
ListName: Israel B, ReturnValue: false
ListName: USA, ReturnValue: false
ListName: EU, ReturnValue: true
ListName: UN, ReturnValue: false

בממשק שתבנו בצד שלכם תוכלו לבחור אם להציג למפעיל את מלוא הפירוט הנ״ל, חלקים ממנו (לדוגמא רק רשימות שהניבו “true”), או תשובה בינארית מסכמת בלבד.

במידה והתקבל הערך “true” באחת הרשימות, המפעיל יוכל להיכנס לממשק של אדוונסקרין באמצעות הדפדפן לקבלת מידע נוסף, ניתוח התוצאה, צירוף הערות, הנפקת PDF וכיוב 

הערות:

  1. במידה ותבחרו לסרוק שם מסויים בעברית ובלועזית, יש להתייחס לכל שפה כסריקה נפרדת עם ID חד ערכי. 
  2. הבדיקה נעשית כנגד האיות המופיע במסמך המזהה של הנסרק וללא וריאציות פונטיות, וכנדרש לפי חוק.
  3. כל הסריקות שתבצעו, בין אם באמצעות הAPI או בממשק הדפדפן, תישמרנה בחשבונכם באדוונסקרין, ותהיינה זמינות לצפייה בכל עת.
  4. יש לקחת בחשבון שאורך הJSON המתקבל (מספר השורות) עשוי להשתנות בהתאם לכמות הרשימות הזמינות, ולתכנן את הצד שלכם בהתאם.