Bu makale, makine çevirisi kullanılarak İngilizce'den çevrilmiştir.
Ekibinizde GraphQL API'nin nasıl kullanılacağını bilen bir geliştiriciniz varsa Webex Events API, güçlü Etkinlik ve ürün kurulumu ve yönetimi otomasyonlarına, üçüncü taraf platform entegrasyonlarına, güçlü çok etkinlikli veri kontrol panellerine ve daha fazlasına açılan kapınız olabilir .
Webex Events API'nin yapabilecekleri
Basitçe söylemek gerekirse API, geliştiricilerin çevrimiçi bir platformdan veri almak veya bu platforma veri koymak için kullanabileceği bir programlama arayüzüdür (bu durumda Webex Events).
API'nin yetenekleri dört temel kavrama göre basitleştirilebilir:
Bir katılımcı, bir Oturum veya bir Etkinliğin tamamı gibi daha önce var olmayan bir şey oluşturun .
API'nin oluşturmak için kullanabileceği her şeyi ve birkaç şeyi daha güncelleyin . Örneğin API, yeni bir katılımcı oluşturmak ve ardından bu katılımcının adını, e-postasını, durumunu, gruplarını, telefon numaralarını ve sosyal hesaplarını düzenlemek için kullanılabilir.
API'nin oluşturmak veya düzenlemek için kullanabileceği her şeyin yanı sıra kullanamayacağı bazı şeyler hakkındaki bilgileri okuyun .
Bazı istisnalar dışında, API'nin oluşturmak için kullanabileceği her şeyi silin .
Bu makalenin 'Geliştiricilerle çalışma' bölümünü okurken bu kavramları aklınızda bulundurun.
Nasıl başlanır?
1. API'ye erişim sağlayın
Zaten Webex Events etkinleştirmiş bir Webex Suite Kurumsal Anlaşması (Suite EA) müşterisiyseniz Webex Events API'sine otomatik olarak erişim elde edersiniz! Diğer tüm müşteriler için API'ye erişim hakkında bilgi edinmek üzere Webex Events kişinizle veya destek ekibimizle görüşün.
2. API anahtarı oluşturun
Artık geliştiricilerinizin kullanması için yeni bir API anahtarı oluşturmanız gerekiyor. API'ye erişiminiz olduğunda Webex Events platformundaki 'Kuruluş ayarları' sayfasına yeni bir sekme eklenir. Yeni sekmeye nasıl erişeceğiniz ve ilk anahtarınızı nasıl oluşturacağınız aşağıda açıklanmıştır:
💡 API sayfasına yalnızca kuruluş yöneticilerinin erişebileceğini unutmayın.
Webex Events platformunun herhangi bir yerinden ekranın sağ üst köşesindeki profil resminize tıklayın ve ardından açılır menüden Organizasyon ayarları'nı seçin.
Kuruluş ayarları sayfasında sol menüdeki API sekmesine tıklayın. Bu sizi API kullanımını gözden geçirebileceğiniz, kullanım günlüklerini dışa aktarabileceğiniz, anahtarları yönetebileceğiniz ve API belgelerimize erişebileceğiniz API kontrol paneline götürür.
Anahtar oluştur'u tıklayın.
'Yeni anahtar oluştur' modunda API anahtarı için bunun ne için kullanılacağını açıklayan bir Etiket girin.
API sürümü açılır menüsünde halihazırda seçili sürüm bulunacaktır; bu nedenle Kaydet'i tıklamanız yeterlidir. Bu, API anahtarını ortaya çıkarır.
Anahtarın yanındaki Kopyala düğmesini tıklayın ve asla kaybolmamasını sağlamak için anahtarı güvenli bir belgeye yapıştırın.
⚠️DİKKAT ! Bu, tam API anahtarına erişilebilen tek zamandır. Modu kapattıktan sonra anahtarın tamamı tekrar okunamaz.
Anahtarı kopyalayıp kaydettikten sonra Kapat düğmesini tıklayın.
Çoğu durumda yalnızca bir API anahtarına ihtiyacınız vardır. Ancak birden fazla ekiple çalıştığınız durumlarda her ekip için bir anahtar oluşturmak isteyebilirsiniz. En iyi çözümü bulmak için geliştiricilerinizle özel kullanım durumlarınız hakkında konuşun.
3. Geliştiricileri API'ye erişmeye davet edin
İlk API anahtarınızı oluşturduğunuzda Webex Events platformunda otomatik olarak yeni bir API ekibi oluşturulur. Geliştiricilerinize Webex Events API'yi denemeleri için erişim vermek, onları bu API ekibine davet etmek kadar basittir. Nasıl yapılacağını öğrenmek için ekipleri, üyeleri ve kredileri yönetme hakkındaki makalemizdeki talimatları izleyin.
💡 API korumalı alanının, Webex Events platformunun test için özel olarak yapılmış ayrı bir sürümü olduğunu unutmayın. Bu, API Korumalı Alan ekibinin tüm yeni üyelerinin, zaten bir platform hesabına sahip olsalar veya kuruluşlarının TOA'sıyla oturum açmış olsalar bile, korumalı alanı kullanmak için yeni bir platform hesabı oluşturması gerektiği anlamına gelir.
API ekibinizdeki kişilerin Webex Events platformunun geri kalanına organizatörlerin yaptığı gibi erişimi yoktur. Bunun yerine, API ekibi üyeleri, gerçek dünya verilerini etkilemeden, oluşturduklarını test edebilecekleri bir API "korumalı alana" erişime sahiptir. Geliştiricilerin Webex Events platformundaki gerçek Etkinliklerinizin ve Uygulamalarınızın bir kısmına veya tamamına da erişebilmesini istiyorsanız onları ilgili API dışı ekiplere davet edin.
4. Bir Etkinlik Hazırlayın
API, Event App ve Onsite gibi bir Etkinlikteki hiçbir ürünü etkinleştiremediğinden, Etkinliğinizde kullanmayı düşündüğünüz her ürünü, gerekli temel bilgileri doldurarak etkinleştirmeniz gerekir.
Geliştiricilerle çalışma
İhtiyacınız olanı oluşturabilmeleri için geliştiricilerinizle net bir şekilde iletişim kurmanız önemlidir. Bu, API'nin Webex Events platformunun hangi bölümlerine erişebileceğini bilmeniz gerektiği anlamına gelir. API'nin tam olarak neye erişip neyi kontrol edebileceğini ve ayrıca geliştiricinizle "aynı dili konuşmanıza" yardımcı olacak birkaç ipucunu öğrenmek için okumaya devam edin.
Temel yeteneklere aşina olduğunuzda geliştiricinizle API ile araçlar ve otomasyonlar oluşturma konusunda konuşmaya başlayabilirsiniz.
Ekipler ve organizasyonlar
Ekipleri ve ekip üyelerini oluşturun, güncelleyin, okuyun ve silin
Olaylar
Oluşturun, güncelleyin, kopyalayın ve okuyun. Etkinlikler silinemez.
Katılımcılar
Oturumlar oluşturun, güncelleyin, okuyun, atayın, gruplara atayın ve sosyal hesap bilgilerini (telefon numarası, sosyal hesap tanıtıcıları vb.) silin. Katılımcılar engellenebilse de silinemez.
Sorular
Oluşturun, güncelleyin, okuyun ve silin
İpucu: API'de sorulara "özel alanlar" adı verilir
Gruplar
Hem özel hem de özel olmayan grupları oluşturun, güncelleyin, okuyun ve silin
Oturumlar
Oluşturun, güncelleyin, okuyun ve silin
Konumlar
Oluşturun, güncelleyin, okuyun ve silin
İpucu: API'de konumlara "bölgeler" adı verilir.
Branded Apps
Branded App adlarını, durumlarını ve atanan Etkinliklerin adlarını okuyun
Event App
Temel Bilgiler, Görünüm ve Web Uygulaması ayarlarının yanı sıra Video Center Kayıtları bilgilerini okuyun
Aşağıdaki Event App özelliklerini ve bunların öğelerini (varsa) oluşturun, güncelleyin, okuyun ve silin:
Gündem
Sponsorlar
Hoparlörler
Katılımcılar
Canlı yayın
Katılımcılar
Özel Liste
Tek Ürün
Web bağlantısı
Web Listesi
QR Kodum
💡 Yukarıda listelenmeyen tüm Event App özelliklerini manuel olarak eklemeniz ve yapılandırmanız gerektiğini unutmayın.
İpucu: API'de özelliklere "bileşenler" adı verilir.
Kayıt
Ödeme ayarları dahil Temel Bilgiler, Görünüm ve Ayarlar bilgilerini okuyun
Biletleri, formları, soruları ve promosyon kodlarını oluşturun, okuyun, güncelleyin ve silin
Siparişleri oluşturma, okuma ve güncelleme
Sipariş ve bilet onay e-postalarını gönderin
Çek veya fatura siparişlerini ödendi olarak işaretleme
Sipariş alıcı bilgilerini güncelleme
Bilet iptali ve iadesi
Promosyon kodlarını oluşturun, okuyun, güncelleyin, silin, duraklatın ve devam ettirin
Vergileri oluşturma, okuma, güncelleme ve silme
İpucu: API'de sorulara "özel alanlar" adı verilir.
Onsite
Temel Bilgiler ve Onsite App bilgilerini okuyun ve güncelleyin
Lead Retrieval ve Live Display
Ürünün etkin olup olmadığını veya Etkinlikte yayınlanıp yayınlanmadığını okuyun
Bilinecek şeyler
Zaman zaman iyileştirmeler ve düzeltmeler içeren API'nin yeni sürümlerini yayınlayacağız. Herkesin yeni sürüme geçmesine yetecek süre boyunca eski sürümleri desteklemeye devam edeceğiz. Yeni sürümler, yaklaşan eski sürüm kullanımdan kaldırma tarihleri ve resmi kullanımdan kaldırma işlemleri hakkında e-posta güncellemeleri göndereceğiz.
Kötüye kullanımı önlemek için API istekleri ölçülür ve sınırlandırılır.
Topluluklar Suite müşterileri için de desteklenir.