צ'אטים

הערות
רמת מומחה
מפתח ה- API צריך להישלח כמזהה מוטבע בכותרת האישור של הבקשה. קבל את מפתח ה- API שלך.
רשימה

נקודת גישה ל API:

GET 
http://tochen.supertech.co.il/api/v1/chats

דוגמת בקשה: 

curl --location --request GET 'http://tochen.supertech.co.il/api/v1/chats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
פרמטר
סוג
תיאור
search
אופציונאלי string
שאילתת החיפוש.
search_by
אופציונאלי string
חיפוש לפי. הערכים האפשריים הם: name עבור שם. Defaults to: name.
favorite
אופציונאלי boolean
סינון לפי מועדף.
sort_by
אופציונאלי string
סינון לפי. הערכים האפשריים הם: id עבור תאריך יצירה, name עבור שם. Defaults to: id.
sort
אופציונאלי string
Sort. הערכים האפשריים הם: desc עבור בסדר יורד, asc עבור בסדר עולה. Defaults to: desc.
per_page
אופציונאלי integer
תוצאות לעמוד. הערכים האפשריים הם: 10, 25, 50, 100. Defaults to: 10.
הצג

נקודת גישה ל API:

GET 
http://tochen.supertech.co.il/api/v1/chats/{id}

דוגמת בקשה: 

curl --location --request GET 'http://tochen.supertech.co.il/api/v1/chats/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
חנות

נקודת גישה ל API:

POST 
http://tochen.supertech.co.il/api/v1/chats

דוגמת בקשה: 

curl --location --request POST 'http://tochen.supertech.co.il/api/v1/chats' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'
פרמטר
סוג
תיאור
name
חובה string
שם הצ'אט.
behavior
אופציונאלי string
ההתנהגות של הסייען.
עדכון

נקודת גישה ל API:

PUT PATCH 
http://tochen.supertech.co.il/api/v1/chats/{id}

דוגמת בקשה: 

curl --location --request PUT 'http://tochen.supertech.co.il/api/v1/chats/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
פרמטר
סוג
תיאור
name
אופציונאלי string
שם הצ'אט.
behavior
אופציונאלי string
ההתנהגות של הסייען.
favorite
אופציונאלי boolean
בין אם הצ'אט מועדף או לא.
מחיקה

נקודת גישה ל API:

DELETE 
http://tochen.supertech.co.il/api/v1/chats/{id}

דוגמת בקשה: 

curl --location --request DELETE 'http://tochen.supertech.co.il/api/v1/chats/{id}' \
--header 'Authorization: Bearer {api_key}'