Алмасуды кім бастайтынын таңдаңыз
UBC Data Bridge API интерфейсі сыртқы жүйелерді басқарылатын ағындарға қосады. Алдымен сұрауды қай тарап бастайтынын және оған қандай нәтиже керектігін анықтаңыз. Бұл «REST API» қосылымының тиісті бағытын таңдауға және қажетсіз аралық бағдарламалауды болдырмауға көмектеседі.
- Сыртқы API шақыру: Data Bridge басқа қызметтен жазбаларды оқиды немесе оған жолдарды жібереді.
- Data Bridge жүйесіне деректер қабылдау: серіктес кесте немесе файл жібереді; қабылданған жеткізілім Production ағынын іске қосады.
- Ағын деректерін жариялау: тұтынушы дайын деректер жиынын оқиды немесе жаңа іске қосу нәтижесін сұрайды.
Ортаны және жауаптыларды дайындаңыз
Әкімші орнатудың HTTPS мекенжайын, прокси арқылы API бағытталуын және «Баптаулар → API → API шектеулері → Data Bridge API қосулы» күйін тексереді. Интеграция иесін, ағын авторын және API кілтінің иесі болатын пайдаланушыны белгілеңіз. Қабылдаушыларға нысандарда нақты құқықтар қажет: API қатынауының өзі кестеге, кубқа немесе пошта серверіне қатынау бермейді.
Сынақ ортасында жеке деректерсіз шағын жиыннан бастаңыз. Өріс схемасын, жазба кілттерін, қабылданатын пішімдерді, күтілетін жауап уақытын және қайталау әрекетін келісіңіз. Ішінара нәтижені кім салыстырып тексеретінін анықтаңыз.
Қосылым мен ағынды баптаңыз
- «Қосылымдар» бөлімінде «REST API» жасап, бағытты таңдаңыз және сынақ пен өндірістік ортаны ажырататын атау беріңіз.
- Бағытқа тән өрістерді толтырыңыз. Сыртқы қызметке мекенжай, әдіс және аутентификация қажет; өз түпкі нүктеңізге API нұсқасы, идентификатор және жауап ережелері қажет.
- Конструкторға тиісті блокты қосыңыз: дереккөз/қабылдаушы қосылымы, «API кіріс деректері» немесе «API деректерін жариялау».
- Түрлендірулерді, тексерулерді және қабылдаушыларды баптаңыз. Кестелерді алдын ала қарап, симуляция жүргізіңіз.
- Сақтап, Production жариялаңыз. Клиент сұраулары жарияланған ағынды пайдаланады; жоба нұсқасын сақтау оны алмастырмайды.
Мекенжайлар және нұсқалар
API нұсқасы түпкі нүкте мекенжайының бөлігі, мысалы: v1 немесе v1.1. Ол UBC Data Bridge 2.1.1 өнім нұсқасынан бөлек. Толық мекенжайды пішіннен көшіріңіз: орнатуда мынадай префикс болуы мүмкін: /databridge , сондай-ақ орта коды және бөлек Designer жолы. Әртүрлі орталардың түпкі нүктелері мен кілттері өзара алмастырылмайды.
Негізгі бағыттар: POST /api/v1/inbound/orders — қабылдау үшін; GET /api/v1/data/stock — деректер жиыны үшін; GET /api/v1/ping — кілт пен уақытты тексеру үшін; және GET /api/v1/flows — қолжетімді ағындар үшін. orders және stock идентификаторлары — өз орнатуыңызда жасалатын мысалдар.
Кілт ауқымы мен пайдаланушы құқықтарын ажыратыңыз
Қорғалған кіріс түпкі нүктесі үшін қажетті ағынға «Жазу» құқығы бар API клиентін жасаңыз; оқуға «Оқу» қажет. Кілт өз иесінің атынан әрекет етіп, оның құқықтарын ешқашан кеңейтпейді. Оны мына арқылы жіберіңіз: Authorization: Bearer немесе X-API-Key, URL ішінде ешқашан бермеңіз. HMAC қосулы болса, әр сұрауға жеке уақыт белгісі мен қолтаңба қажет.
Ашық қатынау тек әдейі қосылған жариялау түпкі нүктесіне қолданылады. Ол қабылдауды, тарихты немесе техникалық құжаттаманы ашпайды. Кілт ережелері мен қол қою мысалы мына нұсқаулықта берілген: API клиенттері нұсқаулығы.
Толық циклді тексеріңіз
Сәтті HTTP сұрауы бизнес-амалдың аяқталғанын дәлелдемейді. Кіріс түпкі нүктесі мына жауапты қайтаруы мүмкін: 202: жеткізілім идентификаторын сақтап, мына сілтемені қадағалаңыз: Location. Сұрау бойынша жариялауда сол іске қосуды күту үшін мынаны пайдаланыңыз: next . Күйді, жол санын және қабылдаушы жүйедегі нақты жазбаны салыстырыңыз.
Жарамсыз өрісті, жетіспейтін құқықты, қайталанған идемпотенттік кілтті және шектен асуды бөлек сынаңыз. «Баптаулар → API → Сұраулар аудиті» бөлімінде сұрауды ағын немесе қосылым бойынша табыңыз. Оны іске қосу журналымен сәйкестендіріп, ішінара немесе расталмаған жазудан кейін қауіпсіз қайталау ауқымын анықтаңыз.
Тиісті нұсқаулықпен жалғастырыңыз
Деректер мен файлдарды қабылдау схемаларды, жеткізілімдерді және кері хабарлауды қамтиды. Сыртқы API шақыру оқуды, беттеуді және жазуды түсіндіреді. Деректерді жариялау өзектілік режимдері мен параметрлерді қамтиды. Ал түпкі нүктенің техникалық анықтамасы интеграторға конфигурация мәліметтерін қалай беруді түсіндіреді.