Сыртқы REST-интеграция (API-кілт)
Сыртқы REST-интеграция — басқа жүйе (ERP, сайттың бэкенді, 1C немесе интеграциялық қабат, өзіңіздің қосымшаңыз) кіру кілті бар стандартты API арқылы LadVen OS-те тапсырмалар мен мәмілелерді жасап, жаңартатын басқарылатын «есік». Бұл орайда ешкім логин мен парольді бермейді әрі әкімші атынан жұмыс істемейді.
Әр шақыру жеке қызметтік аккаунттан (боттан) ең аз қажетті құқықтармен орындалады: тек сіз рұқсат еткен әрекеттер және тек сіз белгілеген бөлімдер, жобалар, воронкалар мен кезеңдер шегінде. Барлық сұраулар порталдың әдеттегі ережелерінен — қолжетімділік, тексерулер, автоматтандыру, хабарландырулар — өтеді әрі әр интеграция бойынша көруге болатын журналға жазылады.
Қосылым Интеграциялар хабында бір рет қосылады (CRM → Интеграциялар бөлімі, /crm/integrations маршруты).
Қашан пайдалану керек
REST-интеграция «басқа жүйеде бірдеңе болғанда — LadVen OS-те автоматты түрде тапсырма немесе мәміле пайда болуы тиіс» дегенде қажет. Тән сценарийлер:
- ERP немесе сайт тапсырыс, өтінім немесе тикет келгенде тапсырма не өтініш жасайды;
- өзіңіздің қосымшаңыз тапсырмалар мен мәмілелерді сыртқы базамен синхрондап ұстайды;
- сыртқы жүйе екінші тарапта жұмыс жүргеніне қарай файлдар тіркейді, пікірлер қалдырады, уақыт белгілейді немесе мәмілені кезеңдер бойынша жылжытады.
Бұл формалар мен веб-хуктардан немен ерекшеленеді: сайт формасы мен веб-хук — CRM-ге өтінімдерді бір жақты қабылдау. REST-интеграция — бағдарламалық екі жақты байланыс: сыртқы жүйе әрі оқиды (тапсырмаларды, мәмілелерді, тарихты алады), әрі жазады (жасайды және жаңартады). Порталдың өзі бұл қосылым арқылы шығыс веб-хуктар таратпайды — сыртқы тарап порталға өзі жүгінеді.
Қалай баптау керек
Қосылым қадамдық шеберде жасалады (CRM → Интеграциялар → «Сыртқы REST-интеграция» қосу). Қадамдар бойынша, жұмыс терминдерінде:
- Атауы мен белсенділігі. Интеграцияға түсінікті атау беріп, оны бірден қосу-қоспауды шешіңіз. Байланыс тексеруін бірден іске қосуға болады.
- Қызметтік аккаунт. Бар ботты таңдаңыз немесе шеберде жаңасын жасаңыз (аты мен логині). Бұл — қызметкер де, әкімші де емес: интеграция оның атынан жұмыс істейді. Әкімші құқықтары бар аккаунтты таңдасаңыз, шебер ескертеді — бұл солай ойластырылған, интеграциялар құқықты ең аз береді.
- Сценарий мен құқық деңгейі. Тапсырмаға қарай операциялар жиынтығын таңдаңыз: «Тапсырмалар мен CRM», «Тек тапсырмалар» немесе «Тек CRM». Содан соң құқық деңгейі: тек оқу, жасау мен өңдеу немесе басқару. Құқықтар кілт берілгенге дейін қызметтік аккаунтқа қолданылады.
- Рұқсат етілген әрекеттер. Интеграцияға орындауға болатын нақты операцияларды белгілеңіз. Қағида — ең аз қажетті: шынымен керектісін ғана қосыңыз. Белгіленбегеннің бәрі орындалуға дейін қабылданбайды.
- Аймақ. Интеграцияны қажетті бөлімдермен, жобалармен, воронкалармен және кезеңдермен шектеңіз. Бұл — аккаунт құқықтарының үстіндегі шеңбер: рұқсат етілген әрекеттің өзі тек белгіленген аймақ ішінде ғана іске қосылады.
- Өрістер мен лимиттер. Интеграция тапсырмалар мен мәмілелердің қай өрістерін өзгерте алатынын, минутына сұрау лимитін мен рұқсат етілген серпілісті, сондай-ақ шақыруларға рұқсат етілген IP-мекенжайлардың ақ тізімін белгілеңіз.
- Кілт жасау және тексеру. Сақтаңыз — портал кіру кілтін нәтиже экранында көшіру түймесімен бір рет көрсетеді. Осы жерде байланыс тексеруін де іске қосуға болады.
Қосылым жасалғаннан кейін онда сұраулар журналы болады: қандай операциялар шақырылды, қандай нәтижемен және әр шақыру бойынша егжей-тегжейлерімен (жазбалардағы құпия деректер жасырылады).
Қауіпсіздік және кіру кілті
REST-интеграция ең аз құқық қағидасына негізделген — бұл бизнес иесі үшін маңызды:
- Кілт бір рет көрсетіледі. Оны көшіріп, бірден құпиялар менеджеріне сақтаңыз. Портал бұл кілтті қайтадан көрсетпейді әрі оны ашық түрде сақтамайды. Кілтті ауыстыру керек болса — осы қосылым үшін шеберден қайта өтіп, оны қайта шығарыңыз.
- Жеке қызметтік аккаунт. Интеграция адам немесе әкімші атынан жұмыс істемейді; оның өз жауапкершілік аймағы мен өз құқықтары бар.
- Қолжетімділік шеңберлері. Рұқсат етілген әрекеттер, аймақ (бөлімдер, жобалар, воронкалар, кезеңдер), өрістердің ақ тізімі, сұрау лимиті мен IP-дің ақ тізімі интеграцияның нені және қайдан істей алатынын шектейді.
- Журнал. Әр шақыру жазылады — интеграция арқылы кім нені өзгерткенін талдауға болады.
Нақты кілтті, авторизация тақырыбын, ақ тізімдегі IP-мекенжайларды немесе қызметтік аккаунттың логинін скриншоттарда ешқашан көрсетпеңіз әрі жарияламаңыз. Иллюстрацияларға анық жалған мәндерді пайдаланыңыз.
Жиі кездесетін қателер
- Интеграцияға қызметтік боттың орнына әкімші аккаунтын беру.
- Ең аз қажетті жиынтықтың орнына керегінен көп әрекетті қосу.
- Жасау кезінде бір реттік кілтті көшірмеу.
- IP-дің ақ тізімі мен сұрау лимитін белгілемеу.
- Аймақты тым кең қою — қажетті бір воронканың орнына бүкіл порталды.
- Порталдың өзі шығыс веб-хуктар жібере бастайды деп күту: интеграция кіріс шақырулармен жұмыс істейді, сыртқы жүйе порталға өзі жүгінеді.
Жұмыс істеп тұрғанын қалай тексеру керек
- Шебердің соңында байланыс тексеруін іске қосыңыз (немесе тексеруді бірден қосуды белгілеңіз).
- Қосылым карточкасы белсенді әрі ақаусыз күйді көрсетіп тұрғанына көз жеткізіңіз.
- Сұраулар журналын қараңыз — онда сәтті шақырулар болуы тиіс.
- Сынақ тапсырмасы немесе мәмілесі дұрыс жауаптымен, воронкамен және кезеңмен пайда болғанын, ал автоматтандыру мен хабарландырулар әдеттегідей істегенін тексеріңіз.