سيرڤ يو للمطوّرين

اربط نظام نقاط البيع أو المحاسبة أو شاشة المطبخ أو أداة الأتمتة بنشاطك على سيرڤ يو. كل نشاط ينشئ مفاتيح API الخاصة به، والمفتاح لا يرى إلا بيانات نشاطه.

احصل على مفتاح من الإعدادات ← المطوّرون.

نقاط الربط

الطريقة	المسار	الصلاحية	مفتاح عدم التكرار	الوظيفة
GET	/api/v1/business	business:read	—	The business this key belongs to
GET	/api/v1/branches	business:read	—	Branches
GET	/api/v1/orders	orders:read	—	List orders
GET	/api/v1/orders/summary	orders:read	—	Sales summary
GET	/api/v1/orders/{id}	orders:read	—	Get an order
POST	/api/v1/orders/{id}/actions	orders:write	مطلوب	Move an order along
POST	/api/v1/cards/lookup	loyalty:read	—	Find a card by phone or scanned card
POST	/api/v1/cards	loyalty:write	اختياري	Join a customer
GET	/api/v1/cards/{id}	loyalty:read	—	Get a card
GET	/api/v1/cards/{id}/events	loyalty:read	—	A card's history
POST	/api/v1/cards/{id}/earn	loyalty:write	مطلوب	Add stamps or points for a sale
POST	/api/v1/cards/{id}/redeem	loyalty:write	مطلوب	Redeem a reward
POST	/api/v1/loyalty-events/{id}/void	loyalty:write	مطلوب	Undo an earn or redeem
GET	/api/v1/menu	menu:read	—	The whole menu
POST	/api/v1/menu/categories	menu:write	اختياري	Create a category
PATCH	/api/v1/menu/categories/{id}	menu:write	اختياري	Update a category
DELETE	/api/v1/menu/categories/{id}	menu:write	اختياري	Delete an empty category
PUT	/api/v1/menu/categories/by-external-id/{externalId}	menu:write	اختياري	Create or update a category by your code
POST	/api/v1/menu/items	menu:write	اختياري	Create an item
GET	/api/v1/menu/items/{id}	menu:read	—	Get an item
PATCH	/api/v1/menu/items/{id}	menu:write	اختياري	Update an item
DELETE	/api/v1/menu/items/{id}	menu:write	اختياري	Delete an item
PUT	/api/v1/menu/items/by-external-id/{externalId}	menu:write	اختياري	Create or update an item by your code
POST	/api/v1/menu/items/{id}/availability	menu:write	اختياري	Mark sold out or back
PUT	/api/v1/menu/items/{id}/stock	stock:write	اختياري	Set an item's stock at a branch
PUT	/api/v1/menu/items/by-external-id/{externalId}/stock	stock:write	اختياري	Set stock by your code
POST	/api/v1/stock	stock:write	اختياري	Set stock for many items at once
GET	/api/v1/webhook-endpoints	webhooks:manage	—	List webhook endpoints
POST	/api/v1/webhook-endpoints	webhooks:manage	—	Create a webhook endpoint
GET	/api/v1/webhook-endpoints/{id}	webhooks:manage	—	Get a webhook endpoint
PATCH	/api/v1/webhook-endpoints/{id}	webhooks:manage	اختياري	Update or turn a webhook endpoint on/off
DELETE	/api/v1/webhook-endpoints/{id}	webhooks:manage	اختياري	Delete a webhook endpoint
POST	/api/v1/webhook-endpoints/{id}/test	webhooks:manage	—	Send a signed test event (ping)
POST	/api/v1/webhook-endpoints/{id}/rotate-secret	webhooks:manage	—	Rotate the signing secret