Skip to main content
Басты бетБлогНұсқаулықтарӨндіріске шығар алдында Tracking API провайдеріне қоюға тиіс 15 сұрақ

Өндіріске шығар алдында Tracking API провайдеріне қоюға тиіс 15 сұрақ

17TRACK

Бақылау API-ын өндірістік ортаға енгізбес бұрын, оның нақты тасымалдаушыларыңыз бен жөнелтілім түрлерін қалай өңдейтінін, оқиғаларының нені білдіретінін, жаңартулардың қалай келетінін және деректер немесе интеграция істен шыққанда не болатынын сұраңыз. Төмендегі 15 сұрақ инженерлік және операциялық топтарға клиенттер, қолдау агенттері немесе автоматтандырылған жұмыс процестері осы деректерге сүйенбес бұрын жауаптарды практикалық тұрғыда тексеруге мүмкіндік береді.

Бақылау API провайдеріне қою керек 15 сұрақ

Сәтті демонстрация өндірістік тест болып саналмайды. Кешіктірілген, қайтарылған және анықтауы қиын сәлемдемелерді қоса отырып, жөнелтілімдердің өкілдік үлгісін пайдаланыңыз. Әр жауап үшін құжаттаманы, үлгілік payload-ты немесе тест нәтижесін сұраңыз. Шешілмеген мәселелердің барлығын іске қосылғаннан кейін қарастырылады деп болжамай, жауапты тұлғасы мен шешім қабылдау күнін көрсетіп тіркеңіз.

Жөнелтілімнің сәйкестігі мен деректер мағынасынан бастаңыз

1. Нақты жөнелтілімдеріміздің қайсысын бақылай аласыз және қамту нені білдіреді?

Провайдерге тасымалдаушыларыңыздың, қызмет түрлерінің, жөнелту және жеткізу бағыттарының, сондай-ақ бақылау нөмірі форматтарының үлгісін беріңіз. Қай жөнелтілімдерді қабылдай алатынын, қай тасымалдаушыларды автоматты түрде анықтай алатынын және қай жерде тасымалдаушы кодын өзіңіз көрсетуіңіз керегін сұраңыз. Тасымалдаушының тізімде болуы оның әрбір қызметі, тасымалдау кезеңі немесе жөнелтілім түрі қолданбаңызға қажет оқиғаларды қалыптастыратынын білдірмейді.

Үлкен көлемдегі бағыттардан және операциялық ерекше жағдайлардан алынған нақты мысалдарды тексеріңіз. Егер бизнесіңізде жөнелтілім тасымалдаушыны жолда ауыстыратын болса, осындай жөнелтілімді де қосыңыз. API жөнелтілімді қабылдамайтынын, оқиғаларды таппай қабылдайтынын немесе егжей-тегжейі шектеулі оқиғаларды қайтаратынын белгілеңіз. Бұл нәтижелер тапсырыстарды басқару жүйесінде әртүрлі өңдеуді талап етеді.

2. Жөнелтілімді тіркеу үшін не қажет және қайталанатын тіркеулердің алдын қалай аласыз?

Қажетті идентификаторларды, тасымалдаушыны таңдау ережелерін, тіркеу уақытын және жарамсыз немесе әлі белсендірілмеген бақылау нөміріне берілетін жауапты нақтылаңыз. Сіздің жағдайыңызда бақылау нөмірінің өзі жеткілікті ме, әлде қосымша ақпарат қажет пе екенін сұраңыз. Бір жөнелтілім бір жүйе немесе бөлек қызметтер арқылы екі рет жіберілсе, не болатынын анықтаңыз.

Жауапкершілігі нақты көрсетілген бір тіркеу процесін құрыңыз: жөнелтілімдерді қай жүйе жібереді, провайдердің идентификаторын қайсысы сақтайды және күмәнді жіберілімді қайсысы қайта орындайды. Егер провайдер сұрауды өңдегеннен кейін уақыт аяқталса, соқыр қайталау екінші жазбаны немесе қайталама төменгі ағын хабарламаларын жасырын түрде тудырмауы керек.

3. Күйлеріңіз нені білдіреді және негізгі тасымалдаушы оқиғаларын тексере аламыз ба?

Күйлер сөздігін және бастапқы оқиғалардың үлгілерін сұраңыз. «Жолда», «жеткізуге шықты», «ерекше жағдай», «жеткізілді» және «қайтарылды» сияқты терминдер пайдалы қысқаша сипаттамалар болғанымен, бизнес ережелеріңізге көбірек мәлімет қажет болуы мүмкін. Провайдер стандартталған күйлермен бірге тасымалдаушының бастапқы сипаттамаларын беретінін және нақты бір күйге дұрыс сәйкеспейтін оқиғаны қалай өңдейтінін анықтаңыз.

Іске қоспас бұрын ішкі күй моделіңізді келісіп алыңыз. Атап айтқанда, қай оқиға жөнелтілімді жабатынын, жеткізу туралы хабарламаны іске қосатынын немесе ерекше жағдай процесін бастайтынын шешіңіз. Негізгі деректер мұндай түсіндіруді қолдамаса, кең күй белгісін нақты физикалық оқиғаның дәлелі ретінде қабылдамаңыз.

4. Қандай уақыт белгілері мен орындар беріледі және оларды қалай түсіндіруіміз керек?

Әр оқиға үшін тасымалдаушы айтқан оқиға болған уақытты провайдердің оны қабылдаған немесе жариялаған уақытынан ажыратыңыз. Уақыт белдеулері, жоқ ығысулар, орын дәлдігі және кейінгі оқиғалардан соң келетін жаңартулар туралы сұраңыз. Жаңадан қабылданған оқиға ескі сканерлеуді сипаттауы мүмкін; тек қабылдау уақыты бойынша сұрыптау жаңылыстыратын уақыт шкаласын тудырады.

Payload-ты дерекқор схемаңызбен және клиентке көрсетілетін бейнемен салыстырып тексеріңіз. Жергілікті уақыт белдеуі белгісіз болғанда оқиғаны қалай көрсететініңізді шешіңіз және дереккөз нақты уақытты немесе орынды бермесе, дәл жеткізу уақытын не орнын көрсетпеңіз.

5. Ерекше жағдайлар, қайтарымдар және жеткізілгенін растайтын дәлелдер қалай көрсетіледі?

Сәтсіз жеткізу әрекеттерінің, кедендегі кідірістердің, мекенжай мәселелерінің, жіберушіге қайтару қозғалыстарының және жеткізілген жөнелтілімдердің мысалдарын сұраңыз. Қай мәліметтер стандартталғанын, қайсысы тасымалдаушыға тән болып қалатынын және сізге маңызды жағдайларда жеткізуді растау қандай да бір дәлелді қамтитынын анықтаңыз. «Жеткізілді» күйі алушының аты-жөнін, қолтаңбасын, фотосын немесе басқа дәлелді қамтиды деп болжамаңыз.

Әр ерекше жағдайды әрекет иесіне сәйкестендіріңіз. Кейбір оқиғалар қолдау қызметінің тексеруін қажет етеді, ал басқалары қосымша ақпарат келгенше клиентке хабарлама жіберуді талап етпейді. Егер дау процесі үшін жеткізілгенін растайтын дәлел қажет болса, оның қолжетімділігі мен форматын бақылау қамтуының өзінен туындайды деп есептемей, бөлек қабылдау критерийі ретінде белгілеңіз.

Жаңартулардың жүйелеріңізге қалай жететінін тексеріңіз

6. Жаңартуларды webhook, polling немесе екеуі арқылы жеткізесіздер ме және әрқайсысын қашан қолдану керек?

Жеткізудің құжатталған моделін, payload үлгілерін, жазылымды баптауды және өткізіп алған жаңартуларды қалпына келтіру нұсқауларын сұраңыз. Webhook ұсынылса, оның өзгерген жөнелтілімді хабарлайтынын, толық snapshot беретінін немесе жеке оқиғаны жеткізетінін анықтаңыз. Polling қажет болса немесе қосалқы әдіс ретінде қолданылса, сәйкес сұрау үлгісін және өзгерген жазбаларды анықтау тәсілін нақтылаңыз.

Модельді жұмыс процесіне қарай таңдаңыз. Клиентке көрсетілетін уақыт шкаласы ерекше жағдайлар кезегіне қарағанда басқа жаңарту кідірісіне төзе алады. Интеграция webhook қолданғаны үшін ғана лезде ескертуге уәде бермеңіз: алдымен тасымалдаушы оқиғаны қолжетімді етуі керек, содан кейін әрбір келесі жүйе оны өңдейді.

7. Хабарламалар қайталанса, кешіксе немесе ретсіз келсе не болады?

Провайдер сәтсіз жеткізулерді қайта орындай ма, қанша уақыт бойы орындайды және endpoint-тен қандай жауап күтеді — сұраңыз. Егер бар болса, тұрақты оқиға немесе жөнелтілім идентификаторын талап етіңіз. Содан кейін бір хабарламаны екі рет жіберіңіз, жаңа оқиғадан кейін ескі оқиғаны жіберіңіз және endpoint-тен уақытша қате қайтарыңыз.

Қабылдаушыңыз тек қауіпсіз қабылдағанын растауға, қайталауларды клиент хабарламаларын қайталамай өңдеуге және оқиғалар ретсіз келгенде дұрыс уақыт шкаласын қайта құруға арналған болуы керек. Егер ұсынылған дизайн әр хабарламаның дәл бір рет жеткізілуіне тәуелді болса, шығарылым алдында бұл болжамға күмән келтіріңіз.

8. Деректердің жаңалығын қалай өлшейміз және оған не әсер етеді?

Провайдер әр кезеңде нені өлшей алатынын сұраңыз: тасымалдаушы оқиғасының уақыты, провайдердің қабылдау уақыты және сіздің жүйеңізге жеткізу уақыты. Бұл өлшемдерді оның кез келген міндеттемесінен бөлек қарастырыңыз. Физикалық қозғалыс пен қолданбаңыздағы жаңарту арасындағы ұзақ үзіліс жоғары ағыннан, провайдердің өңдеуінен немесе өз кезегіңізден туындауы мүмкін.

Пилоттық кезеңде өкілдік жөнелтілімдер үшін осы аралықтарды өлшеп, ауытқуларды зерттеңіз. Ескерту шектерін жұмыс процесіңізге нақты қажет деңгейге қойыңыз. Кешіккен сканерлеу зиянды клиент хабарламасына немесе өткізіліп алған эскалацияға әкелсе, ескірген деректер белгісі немесе қолмен тексеру сияқты қосалқы әдісті анықтаңыз.

9. API тіркелгі деректері мен webhook сұраулары қалай қорғалады?

Аутентификация және тіркелгі деректерін басқару құжаттамасын сұраңыз. Тіркелгі деректерінің қалай берілетінін, ауқымы шектелетінін, жаңартылатынын және қайтарылатынын; тест және өндірістік тіркелгі деректерінің бөлек екенін; webhook қабылдаушысы сұраудың шынайылығын қалай тексере алатынын растаңыз. Қайта ойнатылған webhook сұрауларынан қандай қорғаныс бар екенін де сұраңыз.

Қауіпсіздік тобыңыз провайдердің мүмкіндіктер тізімін ғана емес, ұсынылған іске асыруды да тексерсін. Құпияларды клиенттік код пен журналдарға енгізбеңіз, өндірістік тіркелгі деректеріне қолжетімділікті шектеңіз және оларды ауыстыруды жаттықтырыңыз. Қолданбаңыз құжатталған механизм арқылы кіріс хабарламасын тексере алмаса, webhook негізіндегі жұмыс процесін шығаруға болмайды.

10. Қандай жөнелтілім және клиент деректерін сақтайсыздар және олар қайда жіберіледі?

Интеграцияңыз жіберетін әрбір өрісті, соның ішінде бақылау нөмірлерін, тапсырыс сілтемелерін, мекенжайларды, байланыс деректерін және кез келген реттелетін метадеректерді тізімдеңіз. Қай өрістер міндетті екенін, деректер мен журналдардың қанша уақыт сақталатынын, жою сұрауларының қалай орындалатынын және ұйым талаптарына қатысты қандай өңірлер немесе қосалқы өңдеушілер бар екенін сұраңыз. Тексеруіңіз қажет болған жағдайда шарттық немесе қауіпсіздік құжаттарын алыңыз.

Жіберетін деректер көлемін азайтыңыз. Тапсырыс объектісін толығымен беру ыңғайлы болғаны үшін ғана бақылау интеграциясы клиент ақпаратын қабылдамауы керек. Құпиялылық, заң және қауіпсіздік топтары провайдердің құжатталған өңдеуі жұмыс істейтін нарықтарыңызға сәйкес келе ме, соны шешуі керек.

Сәтсіздік пен операциялық өзгерістерге дайындалыңыз

11. Сұрау шектеулері қандай және клиенттер қателерге қалай жауап беруі керек?

Endpoint, тіркелгі деректері және орта бойынша шектеулерді, сондай-ақ параллелизм ережелері мен ұсынылған қайталау әрекетін сұраңыз. Жарамсыз сұрауды уақытша қызмет мәселесінен және сұрау шектеуге түскен жағдайдан ажыратыңыз. HTTP API үшін күй кодтарының маңызы бар: RFC 6585 тым көп сұрау үшін 429 кодын анықтайды, ал RFC 9110 сервер қателерін қоса алғанда HTTP семантикасын сипаттайды.

Қалыпты күндер мен жүктеме шарықтаулары үшін күтілетін трафикті есептеп, кідіріс жасайтын, жұмысты кезекке қоятын және ұзаққа созылған сәтсіздіктер туралы ескертетін клиентті тексеріңіз. Күмәнді жазу әрекетін қауіпсіз қайталауға болатынын растаңыз. Ақау кезінде трафикті көбейтетін қайталау саясаты қалпына келуді қиындатуы мүмкін.

12. Схема, күй және тасымалдаушы интеграциясындағы өзгерістер қалай хабарланады?

API нұсқалары, қолдаудан шығару туралы ескертулер, өзгерістер журналдары және оқиға өрістерін нұсқаны өзгертпей қосуға болатыны туралы сұраңыз. Тасымалдаушы беретін сипаттамалар мен бақылау әрекеті де өзгеруі мүмкін. Бүкіл API-ға емес, бір тасымалдаушыға немесе бағытқа әсер ететін өзгерісті провайдер қалай хабарлайтынын анықтаңыз.

Қосымша өрістер мен белгісіз күй мәндері үшін икемді талдағыштар жазыңыз, бірақ таныс емес мәнді үнсіз түрде «жеткізілді» немесе «сәтсіз» күйіне айналдырмаңыз. Өзгерген сәйкестікті анықтау үшін бастапқы мәліметтерді жеткілікті көлемде сақтаңыз. Провайдердің ескертулерін қарап, өзгеріс клиенттерге жетпей тұрып интеграциялық тестілерді жаңартатын адамды тағайындаңыз.

13. Өндіріске дейін нені тексере аламыз және тест ортасы нақты әрекетке қаншалықты жақын?

Құжаттамаға, ұсынылса тест ортасына, жауап үлгілеріне және қате жолдарын тексеру тәсіліне қолжетімділікті сұраңыз. Қай сценарийлер модельденетінін және қайсысы нақты жөнелтілімдерді қажет ететінін анықтаңыз. Sandbox кодыңыздың payload-ты өңдей алатынын дәлелдеуі мүмкін, бірақ тасымалдаушы оқиғаларының толықтығы, жаңарту уақыты немесе өңірлік сәйкестік туралы аз ақпарат беруі ықтимал.

Тестілердің екі түрін жүргізіңіз: талдау, қайталау және қауіпсіздікке арналған детерминистік интеграциялық тестілер және операциялық әрекетке арналған шектеулі нақты жөнелтілім пилоты. Қайталама жіберілімдерді, провайдердің уақыт аяқталуын, кешіккен сканерлеуді, қайтарымды және белгісіз күйді қосыңыз. Нәтижелерге инженерия тобы да, ерекше жағдайларға әрекет ететін команда да қол қоюын талап етіңіз.

14. Бақылау жаңартылуы тоқтағанда қандай қолдау және инцидент міндеттемелері қолданылады?

Тіркелгіңіз үшін қандай қолдау арналары барын, инциденттердің қалай хабарланатынын және API немесе хабарлама жеткізуіне қандай шарттық қызмет міндеттемелері қолданылатынын сұраңыз. Жұмыс уақыты туралы міндеттеме API endpoint-ін, бақылау жаңартуларын жеткізуді немесе екеуін де қамтитынын нақтылаңыз. Олар бірдей операциялық нәтиже емес.

Өз runbook-ыңызды құрыңыз: ақауды кім анықтайды, провайдермен кім байланысады, polling немесе басқа қосалқы әдіс қашан пайдаланылады және жаңартулар кешіккен кезде клиенттер нені көреді. Жекелеген жөнелтілімге қатысты деректер мәселесін де, бүкіл платформадағы ақауды да шешу процесін сұраңыз. Эскалация жолын қажет болмай тұрып тексеріңіз.

15. Пайдалану көлемі мен шығындар қалай есептеледі және біз кетсек не болады?

Есепке немесе пайдалану шектеріне қандай әрекеттер кіретінін сұраңыз: жіберілімдер, бақыланатын жөнелтілімдер, сұраулар, хабарламалар немесе басқа бірлік. Ұсынылған келісімде қайталама тіркеулердің, қайталаулардың, белсенді емес жөнелтілімдердің, артық көлемнің және тест трафигінің қалай өңделетінін растаңыз. Шығындарды API демонстрациясына қарап бағаламай, қолданылатын шарттарды жазбаша алыңыз.

Сондай-ақ тоқтатуға дайындалыңыз. Жөнелтілім тарихын қалай экспорттай алатыныңызды, қолжетімділіктің қанша уақыт сақталатынын және белсенді бақылау жазбаларына не болатынын анықтаңыз. Жарамды шығу жоспары провайдерді міндетті түрде ауыстыратыныңызды білдірмейді; ол жолда жүрген жөнелтілімдер туралы көрінуді жоғалтпауға мүмкіндік береді.

Жауаптарды өндірістік шешімге айналдырыңыз

Пайдалы іске қосу алдындағы тексерудің үш нәтижесі болады:

  • Жөнелтілім сәйкестігінің нәтижесі: қандай бақылау жазбалары қабылданғанын және олардың оқиғалары жоспарланған клиенттік және операциялық жұмыс процестерін қолдайтынын көрсететін тексерілген үлгі.
  • Интеграция нәтижесі: аутентификацияны, қайталануларды, қайталауларды, кешіккен оқиғаларды, схема өзгерістерін және өткізіп алған жаңартулардан қалпына келуді өңдеудің көрсетілгені.
  • Операциялық келісім: құжатталған шектеулер, деректерді өңдеу шарттары, қолдау байланыстары, шығын болжамдары және шешілмеген тәуекелдерге жауапты тұлғалар.

Көп тасымалдаушыны қолдайтын бақылау API-ы сіздің жағдайыңызға сәйкес келсе, 17TRACK бағалауға болатын провайдерлердің бірі; оның Tracking API беті және API құжаттамасы интеграцияны осы сұрақтар бойынша тексеруге бастау нүктесі бола алады. Дәл осы стандарт кез келген провайдерге қолданылуы керек: құжаттама интерфейстің қалай жұмыс істеуі керегін көрсетеді, ал өзіңіздің өкілдік жөнелтілім тестілеріңіз оның өндірістік жұмыс процесіңізде шынымен жұмыс істейтінін анықтайды. Оқиғалар тексерілмейінше, клиент хабарламасын немесе ерекше жағдай автоматтандыруын іске қоспаңыз.

FAQ

Sandbox тесті бақылау API-ын өндіріске мақұлдау үшін жеткілікті ме?

Жоқ. Sandbox сұрау форматтары мен кейбір қате өңдеу жағдайларын тексере алады, бірақ тасымалдаушыға тән оқиғаларды, уақытты және нақты бағыттарыңыздағы ерекше жағдай деректерінің пайдалылығын бағалау үшін нақты жөнелтілімдер қажет. Екеуін де бөлек қабылдау критерийлерімен пайдаланыңыз.

Бақылау жаңартулары үшін webhook қолдану керек пе, әлде polling жасау керек пе?

Шешімді провайдердің құжатталған жеткізу мүмкіндіктері мен жұмыс процесіңіздің кідіріске төзімділігіне қарай қабылдаңыз. Қолдау көрсетілген жағдайда webhook қайталама тексерулер қажеттілігін азайта алады, бірақ қабылдаушыңыз қайталаулар мен қайталанатын хабарламаларды өңдеуі керек. Құжатталған шектеулерге байланысты polling негізгі әдіс немесе қалпына келтіру жолы ретінде сәйкес болуы мүмкін.

Бақылау күйлерін сәйкестендірудегі ең жиі қате қандай?

Нақтырақ бизнес тұжырымына триггер ретінде бір кең күйді пайдалану. Мысалы, «жеткізілді» белгісінің өзі дауды шешуге қажет дәлелді бермеуі мүмкін. Триггерлерді провайдер нақты беретін негізгі оқиға мәліметтері арқылы анықтаңыз.

Интеграцияны іске қосу алдында кім мақұлдауы керек?

Инженерия тобы сенімділік пен қауіпсіздікті; операциялар немесе қолдау тобы оқиғалар мен ерекше жағдай жұмыс процестерінің пайдалылығын; ал тиісті құпиялылық, заң және сатып алу үшін жауапты тұлғалар деректерді өңдеу мен коммерциялық шарттарды мақұлдауы керек. Ашық қалған кез келген олқылыққа нақты жауапты адамды тағайындаңыз.

Дереккөздер