API referansı
Tərtibatçılar üçün ictimai API endpointləri: formalar, vidjet, məhsul konfiquratoru və daha çox.
Bu arayış yalnız real, açıq istifadə oluna bilən JSON son nöqtələrini təsvir edir -- hər son nöqtə üçün metod, yol, autentifikasiya növü, məcburi parametrlər, nümunə sorğu və cavab, həmçinin sənədləşdirilmiş xəta kodları. Zentor-da ümumi developer API açarı sistemi mövcud deyil; marşrutdan asılı olaraq giriş ya autentifikasiyasız, ya da Origin yoxlamalı vidjet embed tokeni ilə həyata keçirilir. Daxili idarə paneli marşrutları və Master Admin son nöqtələri bilərəkdən bu açıq arayışa daxil edilməyib, çünki onlara yalnız adi giriş sessiyası vasitəsilə çatmaq mümkündür.
Hər son nöqtə qeydində canlı test qeydi var; o, məlumatın registry sxemindən, avtomatlaşdırılmış testdən, yoxsa faktiki canlı müşahidədən gəldiyini açıqlayır -- işləyən kod yoluna sadəcə oxşarlıq tam sübut sayılmır. Bundan əlavə, texniki cəhətdən uğurlu çağırış həmişə yalnız müvafiq sorğunun özünün emalını təsdiqləyir, e-poçtun çatdırılması, ödənişin tamamlanması və ya başa çatmış SSO girişi kimi sonrakı prosesləri avtomatik təsdiqləmir.
Qoruma müvafiq qrupdan asılıdır. Açıq hüquqi, marketinq və forma son nöqtələri idarə paneli sessiyası tələb etmir. Çat vidjeti isə `X-Widget-Token` başlığından və Origin icazə siyahısından istifadə edir. İdarə paneli girişləri on iki saat etibarlı sessiya JWT-si və yeddi gün etibarlı refresh token qaytarır. SSO son nöqtələri öz birdəfəlik kodları və callback axınları ilə işləyir.
Hər son nöqtə səhifəsini müstəqil müqavilə kimi oxuyun. HTTP metodu, yol, məcburi parametrlər, məlumat tipləri, sorğu gövdəsi, cavab strukturu, xəta kodları və idempotentlik həlledicidir. Nümunə mümkün formatı göstərir, lakin faktiki cavabın yoxlanmasını əvəz etmir. Konfiqurasiya vəziyyəti, validasiyalar, icazələr və xarici provayderlər nəticəni dəyişə bilər.
Təsdiqlənmiş platformaüzrə rate limit 15 dəqiqə ərzində 2000 sorğudur. Hər son nöqtə üçün ayrıca limitlər ardıcıl şəkildə sənədləşdirilməyib. Buna görə müştəri tətbiqləri lazımsız dərəcədə sıx polling dövrlərindən istifadə etməməlidir. İdempotent olmayan əməliyyatlarda avtomatik təkrarlar dublikat qeydlər və ya mesajlar yarada bilər.
Həssas dəyərlər loglara düşməməlidir. Bunlara parollar, sıfırlama tokenləri, təsdiq kodları, vidjet tokenləri, sessiya ID-ləri və real şəxsi nümunə məlumatları aiddir. Sənədləşdirmə və testlərdə anonimləşdirilmiş dəyərlərdən istifadə edin. Canlı test qeydləri faktiki sübutu düzgün əks etdirməlidir.