REST API ve OpenAPI entegrasyon rehberi
REST API ve OpenAPI, desteklenen bildirim ve geliştirici işlemlerini LucidCP’ye bağlar. Canlı kullanımdan önce modülü yapılandırmak, ilgili iş akışına bağlamak ve doğrulamak için bu listeyi izleyin.
Uygulama
Adım adım
-
01
Sağlayıcı hesabını hazırlayın
REST API ve OpenAPI hesabınızın aktif olduğunu doğrulayın. Gereken bilgileri hazırlayın: hedefin gerektirdiği webhook adresi, bot belirteci veya API bilgileri. Sağlayıcı sunuyorsa test ortamını kullanın.
Adım 1 / 7 · LucidCP yönetici panelinde Developer bölümünü açın.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
02
Yapılandırma alanını açın
Geliştirici veya Site Ayarları → Bildirim Kanalları (Developer / Notification Channels) bölümüne gidin ve REST API ve OpenAPI seçin.
Adım 2 / 7 · REST API ve OpenAPI entegrasyonunun yapılandırma ekranını açın.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
03
Erişim bilgilerini girip koruyun
Değerleri birebir kopyalayın, TLS doğrulamasını açık tutun. Canlı ortam sırlarını ekran görüntülerine, destek taleplerine veya tarayıcıda çalışan koda eklemeyin.
Adım 3 / 7 · Entegrasyonun gerektirdiği bağlantı adresini, belirteci veya modül değerlerini girin.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
04
Bağlantıyı test edin
Varsa LucidCP bağlantı testini kullanın. Entegrasyonu bağlamadan önce kimlik doğrulama, ağ veya yetki hatalarını çözün.
Adım 4 / 7 · Kullanılabilir testi çalıştırıp yanıtı aynı ekranda doğrulayın.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
05
İş akışını bağlayın
İlgili eşleştirmeyi yapın: yalnızca hedef sistemin ihtiyaç duyduğu olaylar. Ayarları kaydedip yeniden açın ve seçimin korunduğunu doğrulayın.
Adım 5 / 7 · Gerekiyorsa API erişim anahtarının yetki kapsamını kontrol edin.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
06
Kabul kontrollerini çalıştırın
Şu kontrolleri gerçekleştirin: imzalı bir test olayı ve gönderim günlüğü. Hem LucidCP kaydını hem sağlayıcı tarafındaki sonucu doğrulayın.
Adım 6 / 7 · Sonucu ilgili operasyonel iş akışında doğrulayın.Arayüzü tam çözünürlükte incelemek için görsele tıklayın. -
07
Yayından sonra izleyin
İlk canlı işlemlerde etkinlik günlüklerini, modül kuyruğunu, başarısız işleri ve sağlayıcı günlüklerini inceleyin.
Adım 7 / 7 · Gönderimleri ve hataları etkinlik günlüğünden izleyin.Arayüzü tam çözünürlükte incelemek için görsele tıklayın.
Kontrol listesi
Önerilen uygulamalar
- API erişimine en az yetkiyle başlayın; yalnızca belgelenmiş bir işlem gerektiriyorsa yetkileri genişletin.
- Sağlayıcı erişim bilgilerini düzenli olarak ve sızıntı şüphesi oluştuğunda hemen yenileyin.
Referans
Modül bilgileri
- Entegrasyon
- REST API ve OpenAPI
- Kategori
- Bildirim ve Geliştirici
- Kullanım durumu
- Lisansa dahil
- Katalog sayfası
- Entegrasyonu incele
