Skip to main content
Ana səhifəBloqBələdçilərİnteqrasiyanızı pozmadan göndəriş izləmə API açarlarını necə konfiqurasiya etmək və dəyişdirmək olar

İnteqrasiyanızı pozmadan göndəriş izləmə API açarlarını necə konfiqurasiya etmək və dəyişdirmək olar

17TRACK

Göndəriş izləmə API açarlarını təhlükəsiz şəkildə konfiqurasiya etmək və dəyişdirmək üçün giriş məlumatlarını server tərəfli məxfi məlumat menecerində saxlayın, onlardan istifadə edən hər bir tətbiqi müəyyənləşdirin və köhnə açarı deaktiv etməzdən əvvəl əvəzedici açarı sınaqdan keçirin. Provayderiniz üst-üstə düşən giriş məlumatlarını dəstəkləyirsə, istehlakçıları tədricən köçürün və köhnə açarı yalnız yoxlamadan sonra ləğv edin. Əvəzetmə mövcud açarı dərhal etibarsız edirsə, sıfır dayanma vaxtını fərz etmək əvəzinə, davamlı növbələr və bərpa yoxlamaları ilə koordinasiyalı keçid planlaşdırın.

Göndəriş izləmə API açarlarını necə konfiqurasiya etmək və dəyişdirmək olar

Bu təlimat ecommerce platformalarında, sifarişlərin idarə edilməsi sistemlərində, anbar proqramlarında və müştəri bildiriş xidmətlərində izləmə inteqrasiyalarını dəstəkləyən tərtibatçılar və əməliyyat komandaları üçündür. Məqsəd sadəcə autentifikasiya olunmuş sorğu göndərmək deyil: dəyişiklik boyunca göndəriş qeydiyyatlarını, izləmə yeniləmələrini və sonrakı emalı qorumaqdır.

Provayderinizin giriş məlumatlarını necə idarə etdiyini təsdiqləyin

İstehsal konfiqurasiyasını dəyişməzdən əvvəl provayderin giriş məlumatlarının həyat dövrünü müəyyənləşdirin. “regenerate” kimi işarələnmiş panel əməliyyatı “create another key” əməliyyatından fərqli davrana bilər. Davranışı düymənin etiketinə əsasən təxmin etməyin.

  • Autentifikasiya formatı: Tələb olunan başlığı və ya digər autentifikasiya mexanizmini, endpoint versiyasını və hesabla əlaqəni təsdiqləyin.
  • Üst-üstə düşmə: İki giriş məlumatı eyni vaxtda etibarlı qala bilərmi? Əvəzedici yaratmaq əvvəlki giriş məlumatını dərhal ləğv edirmi?
  • İcazələr: Açarların ayrıca əhatə dairələrinə, mühit məhdudiyyətlərinə və ya giriş nəzarətlərinə malik olub-olmadığını müəyyənləşdirin. Mövcud olduqda bu nəzarətlərdən istifadə edin; onların mövcud olduğunu fərz etməyin.
  • Ləğvetmə: Giriş məlumatını necə deaktiv etməyi və hər hansı yayılma davranışının nəzərə alınıb-alınmayacağını təsdiqləyin.
  • Əməliyyat təsirləri: Kvotaların, qeydiyyatdan keçmiş göndərişlərin və webhook parametrlərinin hesaba, tətbiqə, yoxsa fərdi açara aid olduğunu müəyyənləşdirin.

17TRACK inteqrasiyası üçün rəsmi Tracking API sənədləri və Tracking API məhsul səhifəsi ilə başlayın. İnteqrasiyanız üçün autentifikasiya müqaviləsini təsdiqləmək məqsədilə sənədlərdən istifadə edin və rotasiyanı planlaşdırmazdan əvvəl hesab nəzarətləri və ya dəstək vasitəsilə giriş məlumatlarının həyat dövrü davranışını təsdiqləyin. Aşağıdakı prosedur əməliyyat təlimatıdır; 17TRACK-in konkret ikili açar və ya yenidən yaratma iş axını təklif etdiyinə dair iddia deyil.

Qərar qaydası: Üst-üstə düşən açarlarla yayımı yalnız paralel etibarlılıq təsdiqləndikdə istifadə edin. Əks halda rotasiyanı koordinasiyalı giriş məlumatı əvəzetməsi kimi qəbul edin. Provayderin dəstəkləmədiyi üst-üstə düşmə pəncərəsini yayım strategiyası yarada bilməz.

Açarı sisteminiz boyunca yaymadan bir dəfə konfiqurasiya edin

Autentifikasiyanı serverdə saxlayın

İstehsal giriş məlumatını idarə olunan məxfi məlumat anbarında və ya ekvivalent nəzarət edilən sistemdə saxlayın. Tətbiqin onu iş yükünün identifikasiyası, yayım platforması və ya təsdiqlənmiş başqa mexanizm vasitəsilə əldə etməsinə şərait yaradın. Oxuma icazəsini ehtiyacı olan iş yükləri və operatorlarla məhdudlaşdırın.

Açarı brauzer JavaScript-inə, mobil tətbiq paketlərinə, mənbə koduna, konteyner təsvirlərinə və ya paylaşılan konfiqurasiya nümunələrinə daxil etməyin. Müştəriyə açıq izləmə səhifəsi sizin backend-inizə müraciət etməlidir; backend provayderin giriş məlumatını ifşa etmədən izləmə provayderində autentifikasiya oluna bilər.

OWASP Secrets Management Cheat Sheet mərkəzləşdirilmiş məxfi məlumat idarəetməsini, nəzarətli girişi, auditi və həyat dövrünün idarə edilməsini dəstəkləyir. Onun REST Security Cheat Sheet sənədi də API açarlarını URL-lərə yerləşdirməməyi tövsiyə edir, çünki jurnal və digər emal prosesləri onları ifşa edə bilər. Provayderin sənədləşdirilmiş autentifikasiya metoduna əməl edin və autentifikasiya dəyərlərini sorğu jurnallarından və diaqnostik ixraclardan silin.

Mühitləri ayırın və yayımlanmış versiyanı müəyyənləşdirin

Provayder onları dəstəklədikdə inkişaf, staging və istehsal üçün ayrıca giriş məlumatlarından istifadə edin. Ayrı giriş məlumatları və ya hesablar mövcud deyilsə, bu məhdudiyyəti sənədləşdirin və qeyri-istehsal işlərinin nəzarətsiz istehsal yazmaları aparmasının qarşısını alın.

Məxfi məlumata SHIPMENT_TRACKING_API_KEY kimi məntiqi konfiqurasiya istinadı verin. Məxfi məlumat meneceri versiyasını və ya məxfi olmayan yayım etiketini ayrıca qeyd edin. Bu etiket operatorlara giriş məlumatının özünü yoxlamadan və ya jurnala yazmadan “Bu worker hansı versiyadan istifadə edir?” sualına cavab verməyə imkan verir.

Tətbiqlərin yeniləmələri necə qəbul edəcəyinə açıq şəkildə qərar verin. Başlanğıcda mühit dəyişənini oxuyan proses dəyişmiş dəyəri qəbul etmək üçün adətən yenidən başladılma və ya yenidən yayım tələb edir. Qoşulmuş məxfi məlumat faylı və ya icra zamanı axtarış fərqli yenilənmə davranışına malikdir. Məxfi məlumat anbarının yenilənməsi hər işləyən prosesin əvəzedicini qəbul etdiyini sübut etmir.

Rotasiyadan əvvəl sorğuları bərpa edilə bilən edin

İzləmə işlərini provayderə göndərməzdən əvvəl davamlı saxlayın. Göndəriş qeydiyyatı üçün daxili əməliyyat identifikatorunu, göndəriş istinadını, emal vəziyyətini və təkrar cəhd tarixçəsini qoruyun. Bu biznes yükünü autentifikasiyadan ayrı saxlayın ki, növbəyə alınmış işlər icra zamanı aktiv giriş məlumatından istifadə edə bilsin.

API açarlarını növbə mesajlarına seriyalaşdırmayın. Bu, gecikmiş işləri köhnəlmiş giriş məlumatına bağlayır və məxfi məlumatları növbə yaddaşına, dead-letter növbələrinə və sazlama alətlərinə yayır.

Yazma əməliyyatları üçün təkrar cəhdləri aktivləşdirməzdən əvvəl provayderin dublikatların idarə edilməsi qaydalarını müəyyənləşdirin. Vaxt aşımı qeydiyyatın uğursuz olduğunu sübut etmir: bağlantı kəsilməzdən əvvəl provayder sorğunu qəbul etmiş ola bilər. Mövcuddursa, sənədləşdirilmiş idempotentlik mexanizmindən istifadə edin və ya yenidən göndərməzdən əvvəl göndərişin vəziyyətini uzlaşdırın.

İstehlakçı inventarı və monitorinq bazası yaradın

Ən asanlıqla gözdən qaçan istehlakçı çox vaxt əsas tətbiq olmur. Planlaşdırılmış idxalları, növbə worker-lərini, serverless funksiyalarını, inzibati skriptləri, dəstək alətlərini, fəlakətdən bərpa yayımlarını və hazırda sıfıra miqyaslandırılmış xidmətləri inventarlaşdırın.

Hər bir istehlakçı üçün sahibini, mühitini, məxfi məlumat istinadını, yenilənmə mexanizmini, icra cədvəlini və yayım metodunu qeyd edin. Giriş məlumatlarını yaddaşda saxlaya bilən uzunmüddətli işləri müəyyənləşdirin. Həmçinin konfiqurasiya dəyişikliklərindən sonra köhnə autentifikasiya başlığını saxlaya bilən təkrar istifadə olunan HTTP klientlərini yoxlayın.

Keçiddən əvvəl aşağıdakılar üzrə baza göstərici müəyyənləşdirin:

  • Xidmət, mühit, endpoint və yayım versiyası üzrə qruplaşdırılmış autentifikasiya xətaları.
  • Provayderin cavab gecikməsi, vaxt aşımı, rate-limit cavabları və server xətaları.
  • Növbə dərinliyi, ən köhnə gözləyən işin yaşı və dead-letter həcmi.
  • Uğurlu göndəriş qeydiyyatları və həll olunmamış qeydiyyat cəhdləri.
  • Webhook qəbulu və emalının vəziyyəti, əgər webhook-lar inteqrasiyanın bir hissəsidirsə.

İnteqrasiya sağlamlığını göndərişin hərəkətindən ayırın. Yeni daşıyıcı hadisəsi olmayan bağlama mütləq API xətasının sübutu deyil. Rotasiya zamanı uğurlu autentifikasiya olunmuş sorğular və sağlam emal növbələri çatdırılma statusu dəyişən göndərişlərin sayından daha birbaşa göstəricilərdir.

Dəstəkləndikdə üst-üstə düşən açarlarla rotasiya edin

  1. Aktiv açarı ləğv etmədən əvəzedici yaradın. Köhnə giriş məlumatının qüvvədə qaldığını yoxlayın. Yeni giriş məlumatını ayrıca məxfi məlumat versiyası kimi saxlayın və girişi uyğun şəkildə məhdudlaşdırın.
  2. Əvəzedicini təcrid olunmuş şəkildə təsdiqləyin. Nəzərdə tutulan mühitdə sənədləşdirilmiş, aşağı təsirli əməliyyatdan istifadə edin. Həm HTTP nəticəsini, həm də cavab gövdəsindəki tətbiq səviyyəli nəticəni yoxlayın.
  3. Nümunəvi iş axınını sınaqdan keçirin. Sadəcə əsas bağlantı yoxlamasını deyil, tətbiqinizin həqiqətən ehtiyac duyduğu əməliyyatları təsdiqləyin. Qeydiyyat tələb olunursa, icazəli sınaq göndərişindən istifadə edin və mümkün kvota və ya ödəniş təsirlərini nəzərə alın.
  4. Kiçik istehlakçı qrupuna yayımlayın. Bir worker qrupunu və ya tətbiq instansını əvəzediciyə keçirin, sonra autentifikasiyanı, emal nəticələrini və növbə davranışını yoxlayın.
  5. Qalan bütün istehlakçılara yayın. Hər xidmət yenidən yükləndikcə və ya yenidən başladıqca inventarı yeniləyin. Planlaşdırılmış tapşırıqları, passiv iş yüklərini və bərpa konfiqurasiyalarını daxil edin.
  6. Münasib yoxlama pəncərəsi ərzində müşahidə edin. Müvafiq worker ömrünü, konfiqurasiya keşinin davranışını, təkrar cəhd gecikməsini və iş cədvəlini əhatə edin. Qəbulun sübut edildiyini göstərən universal gözləmə müddəti yoxdur.
  7. Köhnə açarı ləğv edin və yenidən yoxlayın. Köhnə məlumatdan istifadə edən istehlakçıları izləyin, sonra köhnə məxfi məlumat istinadlarını saxlama və insidentə cavab tələblərinizə uyğun olaraq ləğv edin.

Provayder tərəfində açar istifadəsi hesabatı mövcud olmadıqda, qəbulu yoxlamaq üçün yayım qeydlərindən və tətbiqin bildirdiyi məxfi məlumat versiyası etiketlərindən istifadə edin. Bu, əməliyyat sübutu təmin edir, lakin tam istehlakçı inventarını əvəz etmir.

Dərhal əvəzetməni koordinasiyalı keçid kimi idarə edin

Əvəzedicinin verilməsi köhnə açarı dərhal etibarsız edirsə, mərhələli yayım vasitəsilə fasiləsiz autentifikasiyaya zəmanət vermək olmaz. Keçidi elə layihələndirin ki, iş itirilmək əvəzinə təhlükəsiz şəkildə gecikdirilsin.

  1. Giriş məlumatını əvəz etməzdən əvvəl tətbiq yayımını, məxfi məlumat istinadını, operator girişini və bərpa əmrlərini hazırlayın.
  2. Praktik olduqda davamlı yaddaşa iş qəbulunu davam etdirərkən, idarə olunan sərhəddə xarici izləmə sorğularını dayandırın.
  3. İcra olunan sorğuları tamamlayın və ya nəzərə alın. Qeyri-müəyyən yazma nəticələrini avtomatik olaraq uğursuz hesab etmək əvəzinə, uzlaşdırma üçün işarələyin.
  4. Provayder giriş məlumatını əvəz edin, məxfi məlumat anbarını yeniləyin və bütün istehlakçıları yeniləyin.
  5. Tam yığılmış növbəni buraxmazdan əvvəl autentifikasiya və iş axını yoxlamalarını aparın.
  6. Provayderin rate limit-lərinə əməl edərək və dublikat qeydiyyatları yoxlayaraq emalı tədricən bərpa edin.

İnteqrasiya dayana, işi saxlaya və ya giriş məlumatlarını proqnozlaşdırılan şəkildə yeniləyə bilmirsə, planlı rotasiyadan əvvəl bu zəiflikləri aradan qaldırın. Lakin şübhəli komprometasiya halında, müvəqqəti fasiləyə səbəb olsa belə, containment dərhal ləğvetmə tələb edə bilər.

API autentifikasiyasını webhook təhlükəsizliyindən ayrı saxlayın

Xaricə gedən API açarı və daxil olan webhook yoxlama məxfisi fərqli məqsədlərə xidmət edir. Birinin rotasiyasının digərini dəyişdirdiyini və ya hər ikisinin eyni dəyərdən istifadə etdiyini fərz etməyin. Provayderin sənədləşdirilmiş webhook autentifikasiyasına və çatdırılma davranışına ayrıca əməl edin.

Xarici giriş məlumatının keçidi zamanı dayandırmaq üçün ayrıca səbəb olmadıqda webhook qəbulunu işlək saxlayın. Daxil olan mesajları provayderin spesifikasiyasına uyğun təsdiqləyin, arxitektura imkan verdikdə təsdiq göndərməzdən əvvəl onları davamlı şəkildə qəbul edin və emalı dublikat çatdırılmalara dözümlü edin.

Uğurlu autentifikasiya olunmuş API çağırışı webhook çatdırılmasının və ya emalının sağlam olduğunu sübut etmir. İki yolu ayrıca yoxlayın və provayderin dizaynı bunu tələb etmədikcə hər iki giriş məlumatını eyni texniki xidmət əməliyyatında dəyişdirməyin.

Təkrar cəhd fırtınası yaratmadan xətaları araşdırın

Əlamətİlk yoxlamalarTəhlükəsiz cavab
Yayımdan sonra autentifikasiya xətalarıMəxfi məlumat versiyası, başlıq formatı, mühit, boşluqlar, keşlənmiş klientlərKor-koranə təkrar cəhdləri dayandırın; konfiqurasiyanı düzəldin və bir sorğunu təsdiqləyin.
Yalnız bəzi worker-lər uğursuz olurKöhnə proseslər, buraxılmış yayımlar, gecikmiş işlər, köhnə məxfi məlumat keşləriTəsirlənmiş istehlakçıları yeniləyin və versiya etiketlərini müqayisə edin.
Bərpa zamanı rate limit-lərYığılmış işlərin buraxılma sürəti və ümumi paralellikBərpanı məhdudlaşdırın və sənədləşdirilmiş təkrar cəhd qaydalarına əməl edin.
Qeydiyyat vaxt aşımına uğrayırProvayderin əməliyyatı artıq qəbul edib-etməməsiYenidən icra etməzdən əvvəl uzlaşdırın və ya sənədləşdirilmiş idempotentlikdən istifadə edin.

HTTP 401 ümumiyyətlə çatışmayan və ya etibarsız autentifikasiya ilə bağlıdır, 403 isə serverin sorğunu rədd etməsi deməkdir. Provayderə xas cavab gövdələri səbəbi daha dəqiq izah edə bilər. Hər 403-ü vaxtı bitmiş açar kimi təsnif etməyin və hər uğursuz əməliyyatın HTTP xətası statusundan istifadə etdiyini fərz etməyin.

Münasib müvəqqəti xətalar üçün geriçəkilmə və jitter ilə məhdudlaşdırılmış təkrar cəhdlərdən istifadə edin. Etibarsız giriş məlumatını təkrar-təkrar göndərmək onu düzəltməyəcək. Operatoru xəbərdar edin, işi saxlayın və konfiqurasiya xətasının nəzarətsiz sorğu fırtınasına çevrilməsinin qarşısını alın.

Dəyişiklikdən əvvəl geri qaytarma və tamamlanmanı müəyyənləşdirin

Üst-üstə düşən açar rotasiyası üçün geri qaytarma köhnə giriş məlumatı hələ etibarlı və etimadlı olduğu müddətdə istehlakçıları müvəqqəti olaraq ona qaytarmaq demək ola bilər. Ləğvetmədən sonra bu seçim artıq mövcud deyil. Köhnə açar komprometasiya olunmuş ola bilərsə, əlçatanlığı bərpa etmək üçün onu geri qaytarmayın; başqa giriş məlumatı yaradın və irəliləməyə davam edin.

Yalnız bütün inventarlaşdırılmış istehlakçılar əvəzedicidən istifadə etdikdə, autentifikasiya xətaları gözlənilən baza səviyyəsinə qayıtdıqda, növbəyə alınmış iş bərpa olunduqda, qeyri-müəyyən yazmalar uzlaşdırıldıqda və webhook emalı sağlam qaldıqda rotasiyanı tamamlayın. Açarın dəyərini qeyd etmədən sahibini, tamamlanma vaxtını, yayımlanmış məxfi məlumat versiyasını və ləğvetmə nəticəsini qeyd edin.

Davamlı API təhlükəsizliyi üçün rotasiya cədvəlini təşkilati siyasətə, giriş məlumatının ifşa olunması riskinə və provayder imkanlarına əsasən seçin. Şübhəli sızma və ya uyğun olmayan girişdən sonra bu cədvəldən kənar rotasiya edin. Təkrarlana bilən, sınaqdan keçirilmiş prosedur inteqrasiyanın təhlükəsiz şəkildə dəstəkləyə bilmədiyi ixtiyari tezlikdən daha faydalıdır.

FAQ

İzləmə API açarını dayanma vaxtı olmadan dəyişə bilərəmmi?

Potensial olaraq, provayder paralel giriş məlumatlarını dəstəkləyirsə və hər bir istehlakçı ləğvetmədən əvvəl köçürülə bilirsə, bəli. Yenidən yaratma köhnə açarı dərhal deaktiv edirsə, xarici sorğuların idarə olunan şəkildə dayandırılmasını planlaşdırın. Davamlı növbələr bu interval ərzində işi qoruya bilər, lakin provayder bağlantısını fasiləsiz əlçatan etmir.

Növbəyə alınmış göndəriş işlərində API açarı olmalıdırmı?

Xeyr. Göndəriş əməliyyatını və onun emal metadatasını saxlayın, sonra worker icra etdikdə aktiv giriş məlumatını həll edin. Bu, məxfi məlumatın ifşasını azaldır və gecikmiş işlərin etibarsızlaşdırılmış açardan dəfələrlə istifadə etməsinin qarşısını alır.

Açarın dəyişdirilməsi qeydiyyatdan keçmiş göndərişləri silirmi?

Heç bir nəticəni fərz etməyin. Qeydiyyatdan keçmiş göndərişlərin və əlaqəli parametrlərin hesaba, tətbiqə, yoxsa giriş məlumatına bağlandığını təsdiqləyin. Təkcə autentifikasiyanın uğurlu olması əvəzedicinin gözlənilən göndəriş qeydlərinə çıxışı olduğunu sübut etmir.

Açar repozitoriyada və ya jurnalda görünürsə, nə etməliyəm?

Onu potensial olaraq komprometasiya olunmuş hesab edin. Dərhal ləğv edin və ya əvəzləyin, mümkün olduqda giriş və istifadə qeydlərini yoxlayın və insidentə cavab prosesinizə əməl edin. Görünən dəyəri silmək kifayət deyil, çünki nüsxələr tarixçədə, jurnal ixraclarında və ya digər sistemlərdə qala bilər.

Köhnə planlaşdırılmış işin hələ də əvvəlki açardan istifadə edib-etmədiyini necə müəyyənləşdirə bilərəm?

Onun məxfi məlumat istinadını, yayımlanmış konfiqurasiyasını və icra zamanı yenilənmə davranışını yoxlayın. Təhlükəsiz olduqda onu nəzarətli icra ilə başladın və ya növbəti planlaşdırılmış başlanğıcdan əvvəl yayımını təsdiqləyin. Sakit panel nadir istifadə olunan istehlakçının köçürüldüyünü sübut etmir.

Mənbələr