
TixWise developers API
מערכת TixWise מספקת API מלא אשר מאפשר לכם לשלב את TixWise ביישומים שלכם. ה- API מיועד למפתחים ונועד לצורך אינטרגציות מורכבות ושילוב בתהליכים הארגוניים שלכם. באמצעות ה- API תוכלו לשלב את TixWise בכל דרך ולכל פלטפורמה. ה- API של TixWise מבוסס על גבי פרוטוקול HTTP כאשר לכל בקשה מבנה קבוע. TixWise תחזיר תגובה באחד מהפורמטים הבאים לבחירתכם: xml, json ו- nvp.
עקרונות ה- API
בכדי להשתמש ב- API יש לקבע מפתח אבטחה עבור ה- API, לצורך קבלת המפתח יש ליצור קשר עם צוות TixWise.
באמצעות שם המשתמש, הסיסמה ומפתח האבטחה ניתן לבצע פעולות API. נתונים אלו מוגדרים כפרמטרי חובה.
כל בקשת API יש להפנות לכתובת: https://www.tixwise.co.il/he/api.
ניתן לקבוע את ערך ההחזר המבוקש ע"י הגדרת סיומת ל- URL זה, לדוגמה במידה ונרצה ש- TixWise תענה לבקשת API בצורת XML יש לפנות לכתובת: https://www.tixwise.co.il/he/api.xml.
במידה ולא תוגדר סיומת, ערך ברירת המחדל יהיה nvp.
פרמטרים
קיימים מספר פרמטרים קבועים אשר מגדירים את מבנה הבקשות ומוגדרים כחובה עבור כל בקשות ה- API של TixWise. בנוסף עבור כל בקשת ספציפית מתווספים פרמטרים בהתאם לצורך.
פרמטר |
סוג |
תיאור |
USER |
string |
שם המשתמש |
PASS |
string |
סיסמה |
TOKEN |
string |
מפתח האבטחה עבור ה- API |
VERSION |
float |
גרסת ה- API הרצויה, בכדי לאפשר תאימות לאחור TixWise מאפשרת הפעלת גרסאות ישנות יותר של API. |
ACTION |
string |
שם פעולת ה- API הרצויה, יש לשלוח ערך מבין רשימת פעולות ה- API המופיעות בתיעוד. |
בקשה לדוגמא:
https://www.tixwise.co.il/he/api.xml?USER=tix@tixwise.co.il&PASS=123456&TOKEN=tok&VERSION=1.0&ACTION=action&[additionalParamters]
תגובת השרת
לאחר הפעלת פעולת API, שרת TixWise יחזיר תגובה בפורמט הרצוי. מבנה התגובה קבוע ותמיד יכיל את הפרמטרים הבאים:
פרמטר |
סוג |
תיאור |
ACK |
enum |
מציין את סטטוס הצלחת הפעולה, במידה והפעולה הצליחה יחזור SUCCESS, אחרת יחזור ERROR |
VERSION |
float |
גרסת ה- API שהופעל |
RESPONSE |
string |
משתנה בהתאם לבקשה ולסטטוס ההצלחה |
תגובת XML לדוגמא:
<?xml version="1.0" encoding="utf-8" ?> <tixwise_response> <ACK>ERROR</ACK> <VERSION>1.0</VERSION> <RESPONSE>Wrong credentials (USER, PASS, TOKEN)</RESPONSE> </tixwise_response>