Кілттер мен құқықтар

Әр сұрау Authorization тақырыбында құпия кілтті алып жүреді. Кілт бір мекемеге тиесілі және интеграцияға керек әрекеттермен шектеле алады.

curl

curl https://loyaltyfy.io/api/v1/account \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Кілтті Authorization: Bearer <key> түрінде жіберіңіз. Кілтсіз, белгісіз кілтпен немесе кері қайтарылған кілтпен келген сұраулар 401 алады.

Тест және жұмыс кілттері

Кілттер sk_test_ немесе sk_live_ деп басталады. Екеуі де бір мекемемен және бір деректермен жұмыс істейді. Айырмашылығы: кілт жасаған әр нәрсеге livemode белгісі қойылады, сондықтан есептер мен вебхуктар тест трафигін ажырата алады. Әзірлеу кезінде тест кілтін, алғашқы нақты ауысымнан бастап жұмыс кілтін пайдаланыңыз.

Құқықтар

Кілтті белгілі бір құқықтармен шектеуге болады. Кілтте жоқ құқықты талап ететін шақыру 403 және missing_scope кодын алады. Құқықсыз жасалған кілтке толық қолжетімділік беріледі. Мұны тек мекеменің өз скрипттері үшін ұсынамыз.

Құқық	Не рұқсат етеді
members:read	Қатысушыларды іздеу, тізімін алу, тарихын оқу, кодтарды сканерлеу.
members:write	Қатысушыларды тіркеу, профильді өзгерту, карта нөмірін байлау.
members:adjust	Мекеме рұқсат берсе, себебін көрсетіп кэшбэкті қолмен қосу немесе алып тастау.
transactions:write	Чек өткізу және болдырмау, келуді тіркеу, сыйлық беру, транзакциялар тізімін алу.
menu:read	Мәзір мен тағамдарды оқу.
menu:write	Тағам қосу, бағаны өзгерту, стоп-листті басқару.
orders:read	Үстелден келген тапсырыстарды оқу.
orders:write	Тапсырысты қабылдау, қабылдамау және мәртебесін ауыстыру.
devices:write	Киоск пен сканерге арналған жинақ: сканерлеу, келулер, тіркеу және сыйлық беру. Қатысушылар тізіміне және чектерге қолжетімділік жоқ.
catalog:read	Тауарлар мен санат ережелерін оқу.
catalog:write	Тауарларды жүктеу және санаттарға атау беру. Санаттардың ақша ережелерін тек мекеме иесі өзгертеді.
webhooks:write	Вебхук эндпоинттерін басқару.

Әдеттегі жинақтар: кассаға members:read, members:write, transactions:write керек. Кіреберістегі сканерге тек devices:write жеткілікті. Мәзірді синхрондауға menu:read және menu:write керек. POS үстелден тапсырыс қабылдаса, orders:read және orders:write қосыңыз.

Кілттерді қауіпсіз сақтау

Кілттер құпия. API-ды серверден немесе кассаның бэк-офисінен шақырыңыз. Браузерден немесе жария мобильді қосымшадан ешқашан шақырмаңыз.
Біз әр кілттің тек хешін сақтаймыз. Кілт жоғалса, оны басқару панелінде кері қайтарып, жаңасын жасаңыз. Өзгеріс бірден күшіне енеді.
Мүмкіндігінше әр орнатуға (әр кассаға, әр киоскке) бөлек кілт беріңіз. Сонда біреуін кері қайтарсаңыз, қалғандары тоқтамайды, ал басқару панеліндегі Соңғы шақыру қай құрылғы сұрау жіберіп жатқанын көрсетеді.