Не автоматты түрде жасалады
UBC Data Bridge API түпкі нүктесінің сақталған баптаулары бойынша HTML техникалық анықтамасын жасайды. Онда нақты мекенжай, деректер пішімі, өрістер, тексеру ережелері, параметрлер, жауаптар және қолданыстағы шектеулер сипатталады. Схема немесе орындау тәсілі өзгергенде ағын авторы мен интегратор бір ортақ келісіммен жұмыс істей алады.
Қабылдау үшін мысалдар дене немесе файл пішімін, сынақ деректерін, міндетті өрістерді және бірегей кілттерді көрсетеді. Жариялау үшін сақталған нәтижелер не сұрау бойынша орындау, жауап пішімі, сүзгілер және беттеу көрсетіледі. Анықтама түпкі нүктенің күйін көрсетеді: жоба нұсқасын сақтау өзгерістер Production ішінде белсенді дегенді білдірмейді.
1. Түпкі нүкте келісімін дайындаңыз
- Серіктес деректер жиынын түсінетіндей қосылым мен ағынға атау беріңіз, мысалы, «Дүкен қорлары — сынақ».
- Мекенжай мен пішім баптауларын толтырыңыз. Қабылдау үшін шағын жарамды мысал енгізіп, өрістерді жаңартыңыз, түрлерді, міндеттілік белгілерін және кілттерді тексеріңіз.
- Жариялау үшін қажетті нәтижені қосып, орындау режимін таңдаңыз және параметрлерді қарапайым тілмен сипаттаңыз. Міндеттілерін растаңыз.
- Қосылым мен блок баптауларын сақтаңыз. Алдын ала қарап, симуляциялаңыз, қателерді түзетіңіз, содан кейін келісілген ағын нұсқасын жариялаңыз.
- Өзгерістерден кейін анықтаманы қайта ашыңыз. Мекенжайды, Production күйін және жауап мысалын клиент қолдануы тиіс мәндермен салыстырыңыз.
2. Анықтаманы ашып, қатынау беріңіз
API блок қасиеттеріндегі немесе сақталған жариялау қосылымындағы «Техникалық құжаттама» әрекетін қолданыңыз. «API → Құжаттама» қолжетімді түпкі нүктелерді көрсетеді. Блок анықтамасының бағыты: /api/flows/{flow}/blocks/{node}/api-docs; жариялау қосылымы үшін — /api/connections/{connection}/api-docs; каталог үшін — /api/api-docs. Орнату префиксін қосыңыз.
Анықтаманы ашу үшін Data Bridge жүйесіне кірген пайдаланушы қажет. Қатынау ағын редакторына немесе ағынды көре алатын әрі рөлінде «API құжаттамасы» құқығы бар пайдаланушыға беріледі. API кілтінің өзі HTML анықтамасын ашпайды. Деректер жарияланымын ашық ету анықтаманы ашық етпейді. Интеграторға тиісті тіркелгі қатынауын беріп, сұрау кілтін бөлек жеткізіңіз.
3. Мысалдар бойынша клиентті баптаңыз
«Жылдам бастау» бөлімінен бастаңыз: мекенжайды көшіріп, Postman немесе curl баптаңыз. Анықтамада Python мысалдары және аутентификация нұсқаулары бар. Тиісті API клиенттеріне HMAC қажет болса, қол қою нұсқаулары көрсетіледі; өз кілтіңіздің баптауларын ұстаныңыз. Мекенжайлар мен код жанындағы «Көшіру» әрекеттері мысалдарды қолмен қайта термей көшіреді.
Сынақ мәндері мен өз кілтіңізді қауіпсіз жергілікті ортада енгізіңіз. Анықтамада клиент құпиялары жоқ. JSON үшін құрылым мен массив жолын; CSV үшін бөлгіш пен тақырыптарды; файлдар үшін жіберу тәсілі мен атауды сақтаңыз. Сынақ деректерінің кіріс пішімін сұрау пішімімен алмастырмаңыз: бұлар тәуелсіз баптаулар.
4. Сәтті орындауды және күтілетін бас тартуды тексеріңіз
Қабылдау үшін шағын жарамды сұрау жіберіп, жеткізілім аяқталғанша күтіңіз және қабылдаушы нәтижесін салыстырыңыз. Содан кейін міндетті өрістің болмауын, жарамсыз түрді, қайталанатын бірегей кілтті және сол Idempotency-Key арқылы жеткізілімді қайталауды сынаңыз. Бас тарту клиентке түсінікті болуы, ал қайталау қосымша іске қосуды жасамауы керек.
Жариялау үшін бірінші және келесі бетті, міндетті сүзгіні, бос таңдауды және ескірген деректерді сынаңыз. Орындау режимінде бекітілген run.id мәнімен next сілтемесін аяқталғанша қадағалаңыз. Жарамсыз кілтті, тыйым салынған ағынды және жиілік шегін бөлек сынаңыз. HTTP күйін, қате кодын, жеткізілім/іске қосуды және күтілетін жол санын тіркеңіз.
5. Жұмыс келісімін өзекті ұстаңыз
Сәтсіз сұрауды «Баптаулар → API → Сұраулар аудиті» немесе блок мәзіріндегі «API сұраулары» арқылы табыңыз. Әдісті, бағытты, күйді, ұзақтықты және жауапты тексеріңіз. Денені тіркеу аудит баптауларына тәуелді: денеде бизнес-деректер болуы мүмкін, сондықтан қажетті тіркеу ауқымы мен сақтау мерзімін таңдаңыз.
Анықтаманың шектеулер кестесі нақты қолданыстағы мәндерді көрсетеді: сұрау өлшемі, кезек, күту уақыты, бет өлшемі және сол түпкі нүктеге қатысты басқа баптаулар. Шектеулер өзгергенде оны қайта ашыңыз. Жеткізілімнің кіріс деректері аяқталғаннан кейін тазаланады; іске қосу тарихы мен аудиттің өз сақтау ережелері бар. Серіктеспен келісім өзгергенде жаңа мекенжай нұсқасын пайдаланып, өтпелі кезеңде ескі нұсқаны сақтай отырып, көшуді келісіңіз.