API-сипаттамасы
Әзірлеушілерге арналған ашық API-соңғы нүктелері: пішіндер, виджет, өнім конфигураторы және т.б.
Бұл анықтамалық тек нақты, жалпыға қолжетімді JSON эндпоинттерін сипаттайды -- әр эндпоинт үшін әдісі, жолы, аутентификация түрі, міндетті параметрлері, сұрау мен жауап мысалы және құжатталған қате кодтары. Zentor-да әзірлеушілерге арналған жалпы API кілттері жүйесі жоқ; маршрутқа байланысты қолжетімділік аутентификациясыз немесе origin тексерісі бар виджетті енгізу токені арқылы жүзеге асады. Ішкі дашборд маршруттары мен Master Admin эндпоинттері осы ашық анықтамалыққа әдейі енгізілмеген, өйткені оларға тек әдеттегі кіру сессиясы арқылы ғана қол жеткізуге болады.
Әр эндпоинт жазбасында ақпараттың registry схемасынан, автоматтандырылған тесттен немесе нақты тікелей бақылаудан алынғанын көрсететін тікелей тест белгісі бар -- жұмыс істеп тұрған код жолына жай ұқсастық толық дәлел ретінде қарастырылмайды. Сонымен қатар техникалық тұрғыдан сәтті шақыру әрқашан тек сол сұраудың өңделгенін ғана растайды, электрондық хатты жеткізу, төлемді аяқтау немесе SSO арқылы кірудің аяқталуы сияқты кейінгі процестерді автоматты түрде растамайды.
Қорғау тәсілі тиісті топқа байланысты. Ашық құқықтық, маркетингтік және форма эндпоинттеріне дашборд сессиясы қажет емес. Ал чат виджеті `X-Widget-Token` тақырыбын және origin рұқсат тізімін пайдаланады. Дашбордқа кіру кезінде он екі сағат жарамды сессиялық JWT және жеті күн жарамды жаңарту токені беріледі. SSO эндпоинттері өздерінің бір реттік кодтары мен callback процестері арқылы жұмыс істейді.
Әр эндпоинт бетін дербес келісімшарт ретінде оқыңыз. HTTP әдісі, жол, міндетті параметрлер, деректер түрлері, сұрау денесі, жауап құрылымы, қате кодтары және идемпотенттілік шешуші мәнге ие. Мысал ықтимал форматты көрсетеді, бірақ нақты жауапты тексеруді алмастырмайды. Конфигурация күйі, валидациялар, рұқсаттар және сыртқы провайдерлер нәтижені өзгертуі мүмкін.
Расталған платформалық сұраулар шегі 15 минут ішінде 2 000 сұрау. Әр эндпоинтке арналған бөлек шектеулер барлық жерде құжатталмаған. Сондықтан клиенттер қажетсіз жиі polling циклдерін пайдаланбауы керек. Идемпотентті емес операцияларда автоматты қайталау жазбалар немесе хабарламалардың екі рет жасалуына әкелуі мүмкін.
Құпия мәндер журналдарға жазылмауы тиіс. Оларға құпиясөздер, қалпына келтіру токендері, растау кодтары, виджет токендері, сессия идентификаторлары және нақты дербес деректері бар мысал деректер жатады. Құжаттама мен тесттерде анонимделген мәндерді пайдаланыңыз. Тікелей тест белгілері нақты дәлелді дұрыс көрсетуі тиіс.