Açıq API və webhook-lar
Bəzi bizneslər istəyir ki, loyallıq kartı başqa proqramlarla da “danışsın”: bron sistemi, onlayn mağaza və ya öz saytları ilə. Loyever-in açıq API-si və webhook-ları məhz bunun üçündür və planınızdan asılı olaraq istifadə edilə bilər (Pro planına daxildir). Tam tərtibatçı sənədləri api.loyever.com/docs ünvanındadır. Aşağıda onun necə işlədiyini təsvir edirik.
Proqramçınız üçün REST API
API api.loyever.com/v1 ünvanında yerləşir və JSON formatında işləyir. Onun vasitəsilə proqramçı üzvlər və onların kartları (Wallet kartına keçidlər daxil), kartlar və mükafatlar, əməliyyatlar (qazanma, mükafatın verilməsi və geri alma), mesajlar və xatırlatmalarla işləyə bilər.
Məsələn, bu, görüş başa çatanda özü ziyarət əlavə edən bron sistemi, ya da üzvə balansını göstərən sayt ola bilər. Nə quracağınıza siz və proqramçınız qərar verirsiniz.
API tanış qaydalara əməl edir: kursorla səhifələmə; hər POST sorğusunda Idempotency-Key başlığı — təkrar göndərilən sorğu xalı iki dəfə əlavə etmir; hər açar üçün dəqiqədə 120 sorğu limiti, limit aşılanda aydın 429 cavabı və Retry-After; bir formatda xəta mesajları.
Canlı və test açarları
API açarlarını idarəetmə panelinizdə yaradırsınız — canlı və test rejimi üçün ayrıca. Test açarı ilə proqramçı real üzvlərinizə və balanslarınıza toxunmadan hər şeyi yoxlaya bilər.
Sənədlər API-nin özündən (OpenAPI 3.1) yaradılır və api.loyever.com/docs ünvanında dərc olunur. Orada test açarları ilə işləyən, kopyalayıb istifadə edə biləcəyiniz curl nümunələri də var.
Webhook-lar: Loyever sistemlərinizə nə baş verdiyini xəbər verir
API-dən dəfələrlə soruşmaq əvəzinə sisteminiz hadisələrə abunə ola bilər: üzv qoşulur, yenilənir və ya silinir; xal əlavə olunur; əməliyyat geri alınır; mükafat hazır olur və ya verilir; mesaj çatdırılır; Wallet kartı əlavə olunur və ya silinir.
Hər hadisə yalnız sizin və Loyever-in bildiyi gizli açarla imzalanır, qəbul edən tərəf isə 5 dəqiqədən köhnə sorğunu rədd edir. Beləliklə, kopyalanmış sorğunu sonradan təkrar göndərmək mümkün olmur.
Məsələn, mükafat hazır olan kimi öz sisteminizdə qeyd yarada, ya da üzv qoşulanda onu müştəri bazanıza əlavə edə bilərsiniz.
Çatdırılmanı yoxlamaq olur
Ünvanınız 10 saniyə ərzində cavab verməsə, Loyever 1 dəqiqədən 48 saata qədər uzanan cədvəllə yenidən cəhd edir. 3 gün ardıcıl xəta verən ünvan söndürülür və sizə bu barədə e-poçt gəlir.
Çatdırılma jurnalında hər cavabın statusu və qısa hissəsi görünür, çatdırılmanı əl ilə təkrarlamaq olur, “Test hadisəsi göndər” düyməsi isə real hadisələr gəlməmiş quraşdırmanı yoxlamağa imkan verir.