API Dokümantasyon Sayfası
FeedbackPulse, kiracıların mevcut uç noktaları keşfedip test edebilmesi için etkileşimli bir API dokümantasyon sayfası sunar.
API Dokümantasyonuna Erişim
Tam API referansını görüntülemek için kiracı kontrol panelinden /api-docs adresine gidin.
Uç Nokta Gruplandırması
Uç noktalar kaynağa göre düzenlenir:
| Kaynak | Açıklama |
|---|---|
| Gönderimler | Geri bildirim gönderimlerini oluşturma, okuma, güncelleme ve yönetme |
| Ürünler | Ürünleri ve yapılandırmalarını yönetme |
| Kampanyalar | Geri bildirim kampanyaları oluşturma ve yönetme |
| Webhook'lar | Webhook aboneliklerini yapılandırma ve yönetme |
Uç Nokta Ayrıntıları
Her uç nokta girişi şu bilgileri gösterir:
| Alan | Açıklama |
|---|---|
| HTTP Metodu | İstek metodu (GET, POST, PUT, DELETE) |
| URL | Tam uç nokta yolu |
| Parametreler | Tür ve açıklamalarıyla zorunlu ve isteğe bağlı parametreler |
| Örnek İstek | Örnek istek gövdesi veya sorgu parametreleri |
| Örnek Yanıt | Durum koduyla birlikte örnek JSON yanıtı |
Kimlik Doğrulama
API dokümantasyon sayfasında kimlik doğrulama talimatları yer alır. Tüm API istekleri, istek başlığında iletilen bir API anahtarı gerektirir:
Authorization: Bearer {your-api-key}
API anahtarları, kiracı Ayarlar sayfasından oluşturulabilir.
Panoya Kopyalama
Her uç nokta, tek bir tıklamayla panoya kopyalanabilen hazır bir cURL komutu içerir; bu da uç noktaları terminalden test etmeyi kolaylaştırır.