תיעוד API

LionWheel מאפשרת למפתחים ולשותפים התממשקות פשוטה ויעילה דרך ה-API!

מה זה API? ממשק שנועד בשביל לחבר בין מערכות שונות.

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

תיעוד טכני זה מיועד למפתחים אשר מעוניינים ליצור להתממק למערכת LionWheel וליצור משלוחים בצורה אוטומטית.
לכל שאלה ובעיה ניתן לפנות לעזרה במייל support@lionwheel.com

הקדמה

כל הקריאות לממשק יהיו בפרוטוקול https.
הגוף (body) של כל הקריאות והתשובות יהיו בפורמט json.
התאריכים יופיעו בפורמט dd/mm/yyyy.
כל הקריאות לממשק יהיו עם טוקן שישמש לזיהוי ולשיוך לחברת המשלוחים ולהלקוח הנכונים.
חשוב לשים לב שיש שני סוגי קריאות (עם שני סוגי טוקנים שונים):
ממשק של חברת המשלוחים - ישמש את חברת המשלוחים ליצירת משלוחים בעבור הלקוחות שלהם.
טוקן - של חברת המשלוחים. יש לציין את הלקוח את ישוייך המשלוח (company_id) בגוף הבקשה
ממשק של לקוח של חברה המשלוחים - ישמש את הלקוח ליצירת משלוחים (המשלוח ישויך אוטומטית ללקוח ולחברת המשלוחים).

אימות וטוקנים (Authentication)

בכל הבקשות יש להעביר את הטוקן ב query parameter בשם key. לדוגמה:

https://members.lionwheel.com/api/v1/tasks/create?key=my_cool_token

איך אני יודע מה הטוקן בו אני אמור להשתמש?

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

יצירת משלוח

הבקשה

Method: POST

Url: https://members.lionwheel.com/api/v1/tasks/create?key=XXXXXX

Payload - json
Fields in bold are mandatory

description	type	field_name
delivery date (defaults to the current day)	DateTime	pickup_at
the company id to which the task should be associated	integer	company_id
general delivery notes	string	notes
id in external system. should be unique	string	original_order_id
	string	source_city
	string	source_street
	string	source_number
	string	source_floor
	string	source_apartment
	string	source_notes
	string	source_recipient_name
	string	source_phone
	string	source_email
	string	destination_city
	string	destination_street
	string	destination_number
	string	destination_floor
	string	destination_apartment
	string	destination_notes
	string	destination_recipient_name
	string	destination_phone
	string	destination_email
	string	delivery_method
	string	greeting
	string	gifter_name
	string	gifter_phone
	boolean	is_roundtrip
	integer	packages_quantity
amount in cents. $3 should be 300	integer	money_collect
.Json of the content of the task Supported fields: name - string quantity - string sku - string price - string weight - string variant - string notes - string `[{"name":"orange","quantity":"6", "price": "11.99"}, {"name":"apple","quantity":"8", "price": "10.99"}]`	json	line_items

התשובה

Success
Status: 200
Payload - json

description	type	field_name
LionWheel's task id	integer	task_id
task's public id that can be searched by the end user	string	public_id
task's destination region	string	destination_region_str
task's printable label	string	label
task's barcode	string	barcode

Failure

Status: 401 authentication error
Status: 403 data mismatch error

קבלת משלוח

הבקשה

Method: GET

Url: https://members.lionwheel.com/api/v1/tasks/show/<task_id>?key=XXXXXX

Payload - json

התשובה

Success
Status: 200
Payload - json

description	type	field_name
	integer	task_id
delivery date (defaults to the current day)	DateTime	pickup_at
Creation Datetime	DateTime	created_at
the company id to which the task should be associated	integer	company_id
UNASSIGNED: 0, ASSIGNED: 1, ACTIVE: 2, ROUNDTRIP_DELIVERED: 5, COMPLETED: 3, CANCELED: 4	integer	status
assigned driver	integer	driver_id

בדיקות ו-SandBox

ניתן לבקש סביבת בדיקות מ support@lionwheel.com