Жүйелер арасында дерек алмасуды баптаңыз
API қолданбаларға деректерді автоматты түрде алмасуға мүмкіндік береді. Тапсырыстарды қабылдаңыз, өз ережелеріңізбен тексеріңіз және нәтижені басқа жүйелерге жіберіңіз. Деректерді, жауап пішімін және қол жеткізу ережелерін өзіңіз таңдайсыз.
Қабылдау · Дайындау · Ұсыну
Деректерді қабылдаудың, тексерудің, түрлендірудің және жеткізудің ортақ басқарылатын бағыты
Тұтынушыға қажетті өрістері, параметрлері және жаңалық талаптары бар жеке API мекенжайлары
Әр тұтынушыға арналған құрастырылатын құжаттама, түсінікті жауаптар және бапталатын қол жеткізу
Жіберуші қатені деректер жазылғанға дейін көрсін.
Схеманы, міндетті мәндерді және бірегей кілтті анықтаңыз. Қате сұрауға қатысты әрекет таңдалған қате өңдеу ережесіне байланысты.
/api/v1/inbound/orders[
{
"orderId": "ORD-1042",
"amount": "abc",
"orderDate": "2026-10-28"
}
]Өрісті түзету керек
Бірінші жолда amount өрісінде санның орнына мәтін бар. Толық жауап өрісті, жолды және қате себебін көрсетеді.
code: API_INBOUND_INVALIDБұл ереже бойынша қате сұрау ағынды іске қоспайды.Баптауыңызға сәйкес келетін құжаттама.
Әдістер, өрістер, қолжетімділік ережелері, мысалдар және жауаптар — интеграторға арналған бір анықтамалықта.
Басқа жүйелерден деректерді қабылдаңыз
Портал тапсырыстары, филиал қалдықтарының жаңартулары және серіктес файлдары келісілген ағынға бірден түсе алады. «Receive data in Data Bridge» бағытымен REST API қосылымын жасаңыз, нұсқасы мен мекенжайын анықтап, API кіріс блогын қосыңыз. Жарияланған соң қабылданған әр жеткізілім Production ағынын іске қосады. Сұрау денесі JSON, JSON Lines, CSV/TSV және XML пішімдерін қолдайды; файл режимі Excel XLSX/XLSM, CSV, бөлгіші бар TXT, JSON және XML оқиды. Дереккөзге жазбалар жолын, парақты, ауқымды немесе бөлгішті баптаңыз. Серіктестер таныс пішімдерді береді, ал өңдеуді командаңыз басқарады.
- Сұрау денесіндегі кестені немесе multipart/form-data арқылы файлдарды қабылдау
- Бір сұраудағы файл жолдарын өңдеу кестесіне біріктіру
- API мекенжайын нұсқалау және жарияланған ағын логикасын орындау
Деректер келген бойда тексеріңіз
Өрістер мен ұсынылатын түрлерді құрастыру үшін үлгі деректерді беріңіз. Мәтін, бүтін сан, ондық сан, күн, күн-уақыт және логикалық өрістерді қарап шығыңыз; міндетті мәндерді және бір өрісті не құрамдас бірегей кілттерді белгілеңіз. Мысалы, тапсырыс нөмірі мен жол нөмірінің жұбы бір жеткізілімде қайталанбауы тиіс. Бұл мәндерді автоматты өзгертпей, сәйкестікті тексереді. Одан кейін Column mapping өріс атауларын, таңдалуын және ретін анықтайды; анықтамалықпен біріктіру жазбаларды толықтырады; Data cleansing and control реттелген ережелерді қолданады. Бос сома сандық нөлге ауыса алады, ал теріс сома DATA_QUALITY қатесімен өңдеуді тоқтата алады. Қалыпқа келтіру, жолды қабылдамау және тоқтату — үдерісіңізге сай анық таңдалатын шешімдер.
- Кіріс тексерулері пішімдерді, міндетті мәндерді және бір сұраудағы қайталанатын кілттерді қамтиды
- Жазудан бұрын сәйкестендіруді, анықтамалықтарды, формулалар мен сапа ережелерін қолданыңыз
- Жұмыс жеткізілімдерін алмастырмайтын үлгі деректермен алдын ала қарап, симуляция жасаңыз
Бизнес талаптарын анықтаңыз
Жіберушілерді, тұтынушыларды, міндетті өрістерді, сәттілік өлшемдерін және деректердің жаңалық талаптарын анықтаңыз.
Ағынды құрып, тексеріңіз
Құрылымды, сәйкестендіруді және сапа ережелерін баптаңыз. Жарамды және жарамсыз мысалдармен симуляция жасаңыз.
Тиісті қол жеткізуді беріңіз
Клиент құқықтарын, шектерін және кілтін тағайындаңыз немесе ашық жариялауды саналы түрде қосыңыз.
Жариялап, тұтынушыны қосыңыз
Құжаттамаға қол жеткізу беріңіз, Production нұсқасын тексеріңіз, жеткізу не оқуды сынап, аудитті бақылаңыз.
Нені түзету керегін түсіндіріңіз
Жарамсыз кіріс мәндеріне HTTP 422 API_INBOUND_INVALID жауабы жол, баған, өріс, мән, қате түрі мен себебін қайтара алады; қайталанатын кілт мәліметтері өрістер мен бастапқы жолды көрсетеді. Толық мәліметпен бас тартуды, қысқаша қорытындыны немесе тек жарамды жолдарды қабылдауды таңдаңыз. Жауаптарда 100-ге дейін қате және жалпы сандар көрсетіледі. Асинхронды HTTP 202 жеткізілім идентификаторы мен бақылауға арналған Location береді. Аяқталуды күту режимі дайын нәтижені немесе күту уақыты біткенде 202 қайтарады. run.status, run.code, run.message және жазылған сандарды тексеріңіз: HTTP 200 мен delivery.completed өздігінен ағынның сәттілігін білдірмейді. Орындауды құру қатесі орындалу кезіндегі бизнес ереже қатесінен бөлек.
- Жетпейтін бағандар үшін API_INBOUND_FIELDS, жарамсыз мәндер үшін API_INBOUND_INVALID қолданылады
- DATA_QUALITY сияқты ағын тексеру қателері run.code және run.message ішінде көрсетіледі
- Қолтаңбалы кері хабарламалар жеткізілімнің аяқталғанын хабарлайды; ішіндегі орындалу нәтижесін бөлек тексеріңіз
API арқылы деректерді оқып, жіберіңіз
Data Bridge сыртқы қызметке сұрау жібере немесе ағын нәтижесін бере алады. Клиенттерді басқару жүйесінен тапсырыстарды оқыңыз, оларды есеп жүйесінің кодтарымен толықтырып, қаржы бөліміне бірізді топтаманы жеткізіңіз. Оқу GET не POST, жауапты талдау және келесі бет сілтемелері, Link тақырыптары, бет нөмірлері не ығысу арқылы беттеуді қолдайды. Жіберу POST, PUT не PATCH, әр жолға бір сұрау немесе топтамаларды қолдайды. Қабылдаушы талабына сай JSON, XML, нысан деректерін немесе CSV таңдаңыз. Сыртқы аутентификация сол қызметтің деректерімен орындалады: Basic, Bearer, тақырыптағы API кілті немесе OAuth 2.0 client credentials. Ашық қызметке аутентификациясыз кіруге болады.
- Қабылдаушыға арналған жолдарды, параметрлерді, тақырыптарды, пішімді және топтамаларды баптаңыз
- Өрістерді қолмен қайта реттемей, шығыс құрылымын сәйкестендіріңіз
- Бапталған UBC Agent арқылы рұқсат етілген ішкі API-ге қосылыңыз
Қабылдау · Дайындау · Ұсыну
Әр қолданбаға қажетті деректерді бөлісіңіз
Порталға қоймалар бойынша қалдықтар, қолданбаға күндері көрсетілген валюта бағамдары, ал серіктеске қолжетімді ассортимент керек. Дереккөздерді біріктіріңіз, ережелерді қолданыңыз және нәтижені API деректер жариялау блогына қосыңыз. Тұтынушылар келісілген өрістерді JSON, JSON Lines, CSV немесе XML түрінде алады. Мәтін, сан немесе күн параметрлерін баптаңыз: жеке мәндер, тізімдер, ауқымдар, рұқсат етілген шектер мен міндетті кірістер. API мекенжайы сақталған нәтижені ескіруін тексеріп бере алады немесе ағынды сұрау кезінде іске қосады. Ұзақ есептеулер 202 API_RUN_PENDING және сол орындалуды күтуді жалғастыратын келесі мекенжайды қайтарады. Аяқталған нәтижелерді бапталған уақыт бойы қайта пайдалануға болады.
- Дайын жолдарды сүзу немесе мәндерді ағынның іске қосу параметрлеріне беру
- Нәтиженің бірізді беттерін оқу; өзгермеген деректер үшін ETag және 304 қолдану
- Сұрау бойынша орындалу сәтсіз болса, 502 API_RUN_FAILED; сақталған деректер ескірсе, API_DATA_STALE қайтарылады
Әзірлеушілерге дайын анықтамалық беріңіз
Техникалық HTML құжаттама сақталған API баптауларынан, блок конфигурациясынан және үлгі деректерден құрастырылады. Ол толық мекенжайды, пішімді, өрістерді, міндетті мәндерді, бірегей кілттерді, параметрлерді, жауаптарды, қателерді және нақты шектеулерді сипаттайды. Жылдам бастау нұсқаулары мен curl, Postman және Python мысалдары алғашқы сұрауды қайталауға көмектеседі; қажет жерде HMAC мысалдары көрсетіледі. Талаптар сипаттамасын жаңарту үшін баптауларды сақтап, бетті қайта ашыңыз. Оның күйін Production нұсқасымен салыстырыңыз: сақталған жоба — жарияланған өзгеріс емес. Қол жеткізу үшін ағын редакторы немесе құжаттамаға тиісті рұқсаты және ағынды көру құқығы бар пайдаланушы қажет. Клиент құпиялары ешқашан қосылмайды.
- Мысалдар нақты сұрау пішіміне және жариялау режиміне сәйкес келеді
- Пайдаланушы Data Bridge жүйесіне кіреді; тек API кілтімен HTML құжаттаманы ашу мүмкін емес
- Деректерді ашық жариялау техникалық құжаттаманы ашық етпейді
Қабылдау · Дайындау · Ұсыну
Қорғаудың бірнеше деңгейін баптаңыз
Қорғалған API мекенжайлары үшін әр біріктіруге жеке API кілтін беріп, HTTPS қолданыңыз. Кілтті URL ішінде емес, Authorization: Bearer немесе X-API-Key арқылы жіберіңіз. Кілт пайдаланушыға тиесілі: таңдалған ағындарға Read және Write құқықтары оның иесінің ағымдағы құқықтарынан аспайды. Мерзімін, рұқсат етілген IPv4/IPv6 мекенжайларын не CIDR желілерін, сұрау шектерін және әдепкіде қосулы HMAC-SHA256 қолтаңбасын баптаңыз. Қолтаңба уақытты, әдісті, сұрау параметрлері бар жолды және дене хэшін қамтиды. Сағат айырмасы бес минутпен шектеледі, ал қолтаңбаны қайталау қабылданбайды. Ауыстыру кезінде жаңа кілт беріледі; клиентті өшіру қол жеткізуді тоқтатады. Бақылауды әр серіктеске сай таңдаңыз.
- 401 кілт, мерзім немесе қолтаңба мәселесін; 403 мекенжай, пайдаланушы күйі не құқықтар мәселесін білдіреді
- Клиент пен жұмыс кеңістігі сұрау шегіне жетсе, Retry-After бар 429 қайтарылады
- 15 минутта 30 сәтсіз аутентификациядан кейін IP уақытша бұғатталады
Қорғалған API нүктелері үшін
Жабық немесе ашық қол жеткізуді таңдаңыз
Ішкі көрсеткіштерді, серіктеске арналған қалдықтар мен жеке нәтижелерді кілттер және құқықтар арқылы қорғаңыз. Ашық анықтамалық, жалпы каталог не ақпарат виджеті үшін жеке ашық жариялау баптауын қосыңыз. Нақты растаудан кейін мекенжайы бар кез келген адам кілтсіз, қолтаңбасыз және ағын құқықтарын тексерусіз оқи алады. CORS басқа сайттардың сұрауларына рұқсат етеді, сондықтан ашық виджетте құпия дерек сақтаудың қажеті жоқ. Әр IP және жалпы API шектері, беттеу, деректердің жаңалығын тексеру мен аудит сақталады. Тек осы мекенжай ашылады: кіріс сұраулары, тарих, басқа нәтижелер және құжаттама өз қол жеткізу бақылауын сақтайды. Қол жеткізуді қоспас бұрын өрістерді мұқият таңдаңыз.
- Келісілген бизнес біріктірулерін басқарылатын клиент кілттерімен қорғаңыз
- Шектеусіз қол жеткізуге жарайтын деректер үшін ашық мекенжайларды пайдаланыңыз
- Кесте бойынша жаңартылатын сақталған нәтижелерден виджетке дерек беріңіз
Қабылдау · Дайындау · Ұсыну
Қате себебін тарихтан табыңыз
Idempotency-Key бір жеткізілім қайталанғанда жаңа орындалуға жол бермейді; сол кілтпен өзгерген дене жіберілсе, қайшылық туындайды. Әр қайталанған HTTP сұрауына жаңа HMAC қолтаңбасы қажет. Сыртқы қызмет жазуды орындап үлгеруі мүмкін болса, шығыс жазулар автоматты қайталанбайды: жауап жоғалса, қабылдаушы нәтижесін салыстырып тексеру керек. Сұрау өлшемін, кезектерді, жиілікті, күту уақыттарын және кері хабарлама қайталауларын баптаңыз. API аудиті арқылы мекенжайларды, клиенттерді, уақытты, күйлерді және орындалуларды байланыстырыңыз. Дене сақталуы бөлек басқарылады: жеткізілім деректері тазаланғаннан кейін аудит көшірмесі өз баптауларына сай қалуы мүмкін.
- Сыртқы жүйелер арасында ортақ транзакция бар деп есептемей, жеткізілімнің қайталанған орындалуын болдырмаңыз
- Іске енгізбес бұрын сәтті жағдайды, жарамсыз өрістерді, қайталанатын кілттер мен шектеулерді тексеріңіз
- Талаптар өзгергенде келісілген көшу үшін API мекенжайының жаңа нұсқасын қолданыңыз
Сұрақтарыңызға жауаптар.
Деректерді қосу, қолжетімділікті басқару және жұмысты бастау жолдары.
Бөлек API серверін бағдарламалау керек пе?
Data Bridge ішінде API мекенжайлары мен өңдеу блоктарын баптаңыз. Сыртқы қолданбалар келісілген талаптармен HTTP сұрауларын жібереді.
Түрді тексеру мәндерді автоматты түзете ме?
Жоқ. Кіріс құрылымы тексереді; түрлендіру бөлек блоктарда орындалады. Бірегей кілттер бұрынғы жеткізілімдер арасында емес, бір сұраудың ішінде қайталануды анықтайды.
HTTP 202 деректер жазылды дегенді білдіре ме?
Жоқ. Аяқталған соң run.status пен қабылдаушы нәтижесін тексеріңіз. delivery.completed аяқталуды білдіреді, бірақ міндетті түрде сәттілікті білдірмейді.
HMAC пен Idempotency-Key айырмасы қандай?
HMAC әр сұрауды тексеріп, қолтаңбаның қайталануын қабылдамайды. Idempotency-Key қайталанған жеткізілімді алғашқы орындалумен байланыстырады. Қайталауға жаңа қолтаңба қажет.
Тұтынушылар деректерді кілтсіз оқи ала ма?
Иә, ашық жариялау арнайы қосылса. Мекенжайы бар кез келген адам оқи алады; құжаттама мен басқа API бағыттары бақылауда қалады.
Әр оқу дереккөздерге қайта сұрау жібере ме?
Жоқ. Жаңалығын бақылаумен сақталған нәтижелерді немесе бапталатын күтуі және нәтижені қайта пайдалануы бар сұрау бойынша орындалуды таңдаңыз.
Міндетіңізден бастайық.
Қандай деректерді біріктіру керегін айтыңыз. Қалай жұмыс істейтінін түсіндіріп, мысал көрсетеміз.
Мәселеңізді айтыңыз. Шешімге жол табайық.
Деректер көздері, ережелер және нәтижелер — оларды сіздің үдерісіңіз арқылы талқылайық.