API ve Webhook
Kendi sistemlerinizin (ERP, muhasebe, web sitesi) fuar ve katılım bilgilerini okuması için API anahtarı oluşturduğunuz ve olaylar için webhook uçlarını tanımladığınız ekran.
- Menüdeki yeri
- Ayarlar › API ve Webhook
- Gerekli yetki
- API anahtarlarını ve webhook'ları yönetme
- Paket özelliği
- API Erişimi
Ne işe yarar
Bu ekran, efuar'ı kendi sistemlerinize bağlamanın iki yolunu yönetir:
- API anahtarları — kendi sistemleriniz fuarlarınızı ve fuarlara katılan firmaları efuar'dan okur. API yalnız okuma içindir; tutarlar ve kişisel veriler bu sürümde API'de yoktur.
- Webhook'lar — bir firma ya da kişi oluşturulduğunda, bir sözleşme onaylandığında, bir tahsilat işlendiğinde ya da bir ziyaretçi kaydolduğunda efuar sizin sisteminize imzalı bir ileti gönderir.
Ekran iki sekmeden oluşur: API anahtarları ve Webhook'lar. Teknik ayrıntılar (uçlar, alanlar, imza doğrulama) Organizatör API'si ve Webhook'lar sayfalarındadır.
API anahtarları sekmesi
Üstteki Yeni anahtar kutusuna anahtarı kullanacak sistemi anlatan bir ad yazıp (örneğin "Muhasebe sistemi") Anahtar oluştur düğmesine tıklarsınız. Liste şu sütunları gösterir:
| Sütun | Anlamı |
|---|---|
| Ad | Anahtara verdiğiniz ad. |
| Anahtar | Anahtarın yalnız başlangıcı; tamamı bir daha gösterilmez. |
| Oluşturan | Anahtarı oluşturan kullanıcı ve tarih. |
| Son kullanım | Anahtarla yapılan son çağrının zamanı ya da Kullanılmadı. |
| Durum | Etkin ya da İptal edildi. |
Etkin anahtarın satırındaki İptal et düğmesi anahtarı hemen geçersiz kılar. Sağdaki Nasıl kullanılır kartı API'nin adresini, anahtarın nasıl gönderileceğini ve okunabilen uçları özetler. Anahtar her istekte şu başlıkla gönderilir:
Authorization: Bearer fpk_…
Dikkat: Yeni anahtar yalnız oluşturulduğu anda, sayfanın üstünde bir kez gösterilir. Hemen kopyalayıp yalnız kullanacak sistemin ayarlarına yazın; sayfadan ayrıldıktan sonra anahtarın tamamını göremezsiniz. Kaybederseniz yenisini oluşturup eskisini iptal edin.
Webhook'lar sekmesi
Uç eklemek
Uç, iletilerin gönderileceği adrestir. Formda:
- Adres — iletileri alacak adres;
https://ile başlayan tam bir adres olmalıdır. - Açıklama — ucun hangi sisteme ait olduğunu hatırlatan not.
- Bildirilecek olaylar — en az biri seçilir:
| Olay | Ne zaman gönderilir |
|---|---|
| Firma oluşturuldu | Bir firma kaydı oluşturulduğunda. |
| Kişi oluşturuldu | Bir kişi kaydı oluşturulduğunda. |
| Sözleşme onaylandı | Bir satış sözleşmesi onaylandığında; yeni sözleşme sürümünün onayı da dahil, devir sözleşmeleri hariç. |
| Tahsilat alındı | Bir tahsilat işlendiğinde. |
| Ziyaretçi kaydoldu | Bir ziyaretçi bir fuara kaydolduğunda. |
Uç ekle ile kaydettiğinizde ucun imza anahtarı sayfanın üstünde bir kez gösterilir. Bu anahtarı iletileri alacak sisteme verin; sistem her iletinin imzasını bu anahtarla doğrular.
Uç listesi
Her uç için Adres, Olaylar, Durum (Açık, Kapalı ya da Duraklatıldı) ve Son teslim görünür. Satırdaki simgeler:
- Deneme gönder — uca hemen bir deneme iletisi gönderir ve ulaşıp ulaşmadığını söyler.
- Düzenle — adresi, açıklamayı ve olayları değiştirir.
- İmza anahtarını yenile — yeni bir imza anahtarı üretir ve bir kez gösterir; eski anahtarla imzalı ileti artık gelmez.
- Kapat / Aç — ucu geçici olarak durdurur ya da yeniden açar.
- Sil — ucu siler; bekleyen iletileri gönderilmez.
Son iletiler
Alttaki tablo gönderilen son iletileri gösterir: Zaman, Olay, Uç, Durum ve Yanıt (alıcının HTTP yanıtı ya da hata). İleti durumları:
| Durum | Anlamı |
|---|---|
| Sırada | İleti gönderilmeyi bekliyor. |
| Ulaştı | Alıcı iletiyi kabul etti. |
| Yeniden denenecek | Alıcı kabul etmedi; ileti artan aralıklarla yeniden denenecek. |
| Bırakıldı | Bütün denemeler başarısız oldu; ileti artık denenmiyor. |
Yeniden denenecek ya da Bırakıldı durumundaki iletiyi Yeniden gönder ile yeniden sıraya alabilirsiniz.
Nasıl yapılır
Muhasebe sisteminize API erişimi vermek
- API anahtarları sekmesinde Yeni anahtar kutusuna "Muhasebe sistemi" gibi bir ad yazın.
- Anahtar oluştur düğmesine tıklayın.
- Sayfanın üstünde görünen anahtarı kopyalayıp muhasebe sisteminizin ayarlarına yazın.
- Sistem ilk çağrıyı yaptığında Son kullanım sütununda zamanı görürsünüz.
Sözleşme onaylarını kendi sisteminize bildirmek
- Webhook'lar sekmesinde Adres alanına sisteminizin adresini yazın.
- Bildirilecek olaylar altında Sözleşme onaylandı kutusunu işaretleyin.
- Uç ekle düğmesine tıklayın ve gösterilen imza anahtarını sisteminize verin.
- Satırdaki Deneme gönder ile iletinin ulaştığını doğrulayın.
Kurallar ve dikkat edilecekler
- Ekran yalnız paketinizde API Erişimi özelliği açıksa görünür. Özellik kapanırsa anahtarlar reddedilir ve bekleyen iletiler gönderilmez.
- Bir firmada en fazla 10 etkin anahtar ve en fazla 10 webhook ucu olabilir.
- Anahtar firmanındır ve firmanın bütün şubelerindeki fuarları okur; kullanıcıların şube erişiminden bağımsızdır. Her sistem için ayrı anahtar oluşturun; biri sızarsa yalnız onu iptal edersiniz.
- İptal edilen anahtar hemen hiçbir şey açmaz. İptal geri alınamaz; yeniden erişim için yeni anahtar oluşturulur.
- Alıcı iletiyi kabul etmezse ileti artan aralıklarla yeniden denenir; ilk gönderimle birlikte en çok 6 deneme yapılır. Art arda 20 başarısız denemede uç Duraklatıldı durumuna geçer; sorunu giderdikten sonra ucu yeniden açın.
- Kişi oluşturuldu ve Ziyaretçi kaydoldu iletileri kişisel veri taşır; bu olaylar için yalnız kendi sisteminize ait bir adres tanımlayın.