1. Ресурс қосылымын жасаңыз
«Қосылымдар → REST API» бөлімінде «Сыртқы API шақыру» таңдаңыз. Түсінікті атауды, қызметтің негізгі HTTPS мекенжайын және мынадай салыстырмалы ресурс жолын көрсетіңіз: /orders. Бір қосылым бір ресурсты және сұрау әдісін сипаттайды. Басқа ресурс не әдіс үшін бөлек қосылым жасаңыз: әр интеграцияның мақсаты мен құқықтары анық болып қалады.
Жолға сұрақ белгісінен кейін сұрау параметрлерін қоспаңыз. Негізгі параметрлерді әр жолға бір name=value түрінде енгізіңіз; дереккөз блогы өз параметрлерін қоса алады. Қосымша тақырыптарды мына түрде енгізіңіз: Name: value. Authorization қоса алғанда, құпиялар кәдімгі тақырыптарға емес, арнайы аутентификация өрістеріне енгізіледі.
2. Аутентификация мен желіні баптаңыз
Сыртқы қызмет қолдайтын тәсілді таңдаңыз: аутентификациясыз, Basic, Bearer, тақырыптағы API кілті немесе OAuth2 client credentials. Basic үшін пайдаланушы аты мен құпиясөз; API кілті үшін тақырып атауы мен кілт; OAuth2 үшін токен түпкі нүктесі, Client ID, клиент құпиясы және қажетті scope керек. Data Bridge кіріс API кілті сыртқы қызметтің тіркелгі деректерін алмастырмайды.
DNS, порт, TLS сертификатына сенім және тіркелгі құқықтарын тексеріңіз. Ішкі ресурс үшін келісілген желілік бағытты немесе бапталған UBC Agent қолданыңыз. «Тексеру» қолжетімділікті тексереді; оның сәттілігі әр ресурсты оқуға немесе дерек жазуға құқықты кепілдемейді. Диагностиканы қарап, қосылымды сақтаңыз.
3. Жауапты оқып, талдаңыз
Дереккөз үшін GET немесе POST қолданыңыз. POST оқуының таңдалған пішімдегі өз сұрау денесі бар; бұл қабылдаушының кесте жолдарын жіберуінен бөлек. Жауап пішімін нақты көрсетіңіз немесе Content-Type бойынша анықтаңыз: JSON, XML, CSV/TSV не JSON Lines. Кодтауды, бөлгішті және тақырыптарды тексеріңіз.
Төмендегі жауап үшін жазбалар жолы: data.items. XML үшін мынадай элемент жолы қажет: ./item; қажет болса ата-аналық атрибуттарды қосуға болады. Ішкі нысандар нүктемен бөлінген бағандарға айналады. Қосылымды дереккөз ретінде қосып, сүзгі немесе сәйкестендіру құрастырмас бұрын өрістерін алдын ала қараңыз.
{"data":{"items":[{"orderId":"ORD-1042","status":"open","amount":1250}]}}4. Толық беттеуді баптаңыз
Қызмет келісіміне сай таңдаңыз: бір жауап, JSON/XML ішіндегі келесі сілтеме, Link тақырыбы, бет нөмірі немесе ығысу. Бет нөмірлері үшін параметр атауын, бірінші бетті және өлшемді; ығысу үшін ығысу параметрі мен топтама өлшемін орнатыңыз. Дене ішіндегі келесі сілтеменің нақты жолын көрсетіңіз; ол сол серверде қалуы керек.
Ең көп бет санын және жауап кестесінің өлшемін шектеңіз. Мысалы, мына тәсілді пайдаланатын қызметті: page және page_sizeбірінші беті дұрыс көрінсе де, ығысу бойынша беттеу ретінде оқуға болмайды. Кемінде екі бетті, соңғы толық емес бетті және кілттердің қайталанбауын тексеріңіз. Дене ішіндегі келесі сілтемелер CSV немесе JSON Lines үшін қолданылмайды.
5. Қабылдаушы арқылы жолдарды жіберіңіз
Жазу үшін POST, PUT немесе PATCH және JSON, XML, пішін не CSV пішімін таңдаңыз. Қабылдаушы денені кіріс кестесінен құрады. JSON жол нысанын немесе нысандар массивін жібереді; қажет болса топтама массивінің кілтін орнатыңыз. XML үшін жол элементі мен топтама түбірі қажет. Пішін деректері әр жолға тек бір сұрауды қолдайды. CSV тақырыптар мен мәндерді қамтиды.
Жеке сұраулар мынадай жолды пайдалана алады: /orders/{{orderId}}. Топтама өлшемін API талаптарына сай орнатып, шағын сынақ дайындаңыз және қабылдаушыны кілт бойынша тексеріңіз. PUT немесе PATCH мағынасын сыртқы қызмет анықтайды: оның келісімінде болмаса, автоматты upsert немесе идемпотенттілік бар деп есептемеңіз.
6. Қателер мен журналды тексеріңіз
«Баптаулар → API → API шектеулері» бөлімінде әкімші қайталау санын, кідірістерді, Retry-After және серверлік уақытша тоқтатқышты басқарады. Уақытша оқу қателері қайталануы мүмкін; жазу тек анық қабылданбаған жағдайда, мысалы қосылым орнағанға дейінгі ақауда немесе HTTP 429 кезінде қайталанады. Жазу жауабы жоғалса, нәтиже анықталмаған күйде қалады: алдымен қабылдаушыны салыстырып тексеріңіз.
Блоктың контекст мәзіріндегі «API сұраулары» арқылы әдісті, мекенжайды, күйді және ұзақтықты қараңыз. 401/403, бос жауаптарды, схема өзгерістерін және бет шектеулерін сынаңыз. Журналды блок нәтижесімен және соңғы жазба санымен салыстырыңыз. Сыртқы сұрауларды басқарылатын қабылдау басқа бағытты пайдаланады: кіріс API түпкі нүктесі.