Geri bildiriminiz için teşekkürler.
Geri Bildirim?Ekibinizde GraphQL API'sini nasıl kullanacağını bilen bir geliştirici varsa, Webex Events API güçlü Etkinlik ve ürün kurulum ve yönetim otomasyonlarına, üçüncü taraf platform entegrasyonlarına, güçlü çoklu olay veri panolarına ve daha fazlasına açılan ağ geçidiniz olabilir.
Webex Events API'si neler yapabilir
Basitçe söylemek gerekirse, API, geliştiricilerin çevrimiçi bir platformdan veri almak veya veri koymak için kullanabilecekleri bir programlama arayüzüdür - bu durumda, Webex Events.
API'nin yetenekleri dört temel kavramla basitleştirilebilir:
-
Katılımcı, Oturum veya tüm Etkinlik gibi daha önce var olmayan bir şey oluşturun.
-
API'nin oluşturmak için kullanılabileceği her şeyi ve birkaç şeyi daha güncel leyin. Örneğin, API yeni bir katılımcı oluşturmak ve ardından 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 kullanılabileceği herhangi bir şey ve yapamadığı bazı şeyler hakkında bilgi okuyun.
-
API'nin oluşturmak için kullanılabileceği her şeyi sil in, bazı istisnalar dışında.
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 Ev Webex Suite ents etkinleştirmiş bir Kurumsal Sözleşme (Suite EA) müşterisiyseniz, Webex Events API'sine otomatik olarak erişebilirsiniz! Diğer tüm müşteriler için, API'ye erişim hakkında bilgi edinmek için Webex Events irtibat kişinizle veya destek ekibimizle görüşün.
2. Bir API anahtarı oluşturun
Şimdi 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 resminizi tıklayın, ardından açılır menüden Organizasyon ayarlar ı'nı seçin.
-
Kuruluş ayarları sayfasında sol menüdeki API sekmesini tıklatın. Bu sizi API kullanımını inceleyebileceğiniz, kullanım günlüklerini dışa aktarabileceğiniz, anahtarları yönetebileceğiniz ve API belgelerimize erişebileceğiniz API panosuna götürür.
-
Anahtar oluştur'a tıklayın.
-
'Yeni anahtar oluştur' modunda API anahtarı için ne için kullanılacağını açıklayan bir Etiket girin.
-
API sürümü açılır men üsünde mevcut sürüm zaten seçilmiş olacaktır, bu yüzden Kaydet'i tıklam anız yeterlidir. Bu API anahtarını ortaya çıkarır.
-
Anahtarın yanındaki Kop yala düğmesini tıklayın ve asla kaybolmamasını sağlamak için anahtarı güvenli bir belgeye yapıştırın.
UYARI! Tam API anahtarına erişilebilen tek zamandır. Modali kapattıktan sonra tam anahtar 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'sini denemek için erişim sağlamak, onları bu API ekibine davet etmek kadar basittir. Nasıl yapılacağını öğrenmek için ekipleri, üyeleri ve kredileri yönetme hakkındaki makal emizdeki talimatları izleyin.
Unutmayın, API sanal alanı, test için özel olarak hazırlanmış Webex Events platformunun ayrı bir sürümüdür. Bu, API Sandbox ekibinin tüm yeni üyelerinin sanal alanı kullanmak için yeni bir platform hesabı oluşturmaları gerektiği anlamına gelir, zaten bir platform hesabı olsa veya kuruluşlarının SSO'su ile oturum açmış olsalar bile.
API ekibinizdeki kişiler, Webex Events platformunun geri kalanına organizatörlerin yaptığı gibi erişemez. Bunun yerine, API ekibi üyeleri, gerçek dünya verilerini etkilemeden oluşturduklarını test edebilecekleri bir API “sanal alanına” erişebilir. Geliştiricilerin Webex Events platformundaki gerçek Etkinliklerinizin ve Uygulamalarınızın bir kısmına veya tümüne de erişmesini istiyorsanız, onları ilgili API olmayan ekiplere davet edin.
4. Geliştiricilerinize karşı nazik olun
Bu çok önemli, bu yüzden bunu bir adım attık. 😉
“Roma bir günde inşa edilmedi” ve iyi bir API entegrasyonu da değildi. Geliştiricilerinize iyi bir arkadaş olun ve entegrasyon sunmalarını beklemeden önce Webex Events API'sini hızlandırmaları için onlara bolca zaman verin. Baskı yapılmadıkları için minnettar olacaklar.
En azından, entegrasyonların çalışmasına ihtiyaç duymadan en az altı ay önce geliştiricilerinizle görüşmelere başlamanızı öneririz. Bu konuşmalara nasıl hazırlanacağınızı ve yapacağınızı öğrenmek için okumaya devam edin.
Geliştiricilerle çalışmak
Geliştiricileri Webex Events Sandbox ekibinize davet ettikten sonra ilk sorularınızdan biri “Entegrasyonları oluşturmak ne kadar sürer?” olabilir. Bu soruyu yanıtlamak, kaç geliştiriciyle çalıştığınız, entegrasyonlar üzerinde ne kadar zaman geçirdikleri, entegrasyonların ne kadar karmaşık olduğu ve daha fazlası dahil olmak üzere birçok faktöre bağlıdır.
Yalnızca geliştiricileriniz, yalnızca birkaç önemli adımdan sonra bir entegrasyonun kurulmasının ne kadar süreceğini size söyleyebilir:
-
İlk olarak, API'nin neler yapabileceğini öğrenmek için aşağıdaki bölümleri okuyun. Bu, ihtiyaçlarınızı geliştiricilerinizle net bir şekilde iletebilmeniz için neyin mümkün olduğunu anlamanıza yardımcı olacaktır.
-
Geliştiricilerinizle tanışın, API belgelerimizi onlarla paylaşın ve ne istediğinizi tartışın. Sizin için neler yapıp yapamayacakları hakkında temel geri bildirimler verebilecekler. Ancak, Webex Events API'sine aşina olana kadar size belirli zaman çizelgeleri veremezler.
-
Geliştiricilerinize API'yi tanımaları için zaman verin. Etkinlikleriniz, verileriniz, Webex Events platformu ve diğer her şeyle ilgili kavramsal veya pratik soruları yanıtlamak için kendinizi hazır hale getirin.
API neler yapabilir
API'nin iki temel işlevi vardır:
-
O ku - Webex Etkinliklerinden veri alın, böylece verileri inceleyebilir veya farklı bir sisteme çekebilirsiniz.
-
Güncell eme - Yeni öğeler oluşturmak veya katılımcılar gibi verileri başka bir platformdan senkronize etmek için Webex Etkinliklerine veri koyun. Webex Events platformunda bir şeyi değiştiren her şey bir Güncellemedir.
Ekipler ve organizasyonlar
-
Ekipler ve ekip üyeleri oluşturma, güncelleme, okuma ve silme
Olaylar
-
Güncelleyin, klonlayın ve okuyun. Etkinlikler API ile oluşturulamaz veya silinemez.
Katılımcılar
-
Sosyal hesap bilgilerini oluşturun, güncelleyin, okuyun, Oturumlara atayın, gruplara atayın ve sosyal hesap bilgilerini silin (telefon numarası, sosyal hesap tutacakları vb.). Katılımcılar engellenebilmelerine rağmen silinemez.
Sorular
-
Oluşturma, güncelleme, okuma ve silme
İpucu: API'de sorulara “özel alanlar” denir
Gruplar
-
Hem özel hem de münhasır olmayan gruplar oluşturun, güncelleyin, okuyun ve silin
Oturumlar
-
Oluşturma, güncelleme, okuma ve silme
Konumlar
-
Oluşturma, güncelleme, okuma ve silme
İpucu: API'de konumlara “bölgeler” denir.
Markalı Uygulamalar
-
Markalı Uygulama adlarını, durumlarını ve atanan Etkinliklerin adlarını okuyun
Etkinlik Uygulaması
-
Temel Bilgiler, Görünüm ve Web App Ayarlar ve Video Merkezi Kayıtları bilgilerini okuyun
-
Uygun olduğunda aşağıdaki Etkinlik Uygulaması özelliklerini ve öğelerini 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 Öğe
-
Web Bağlantısı
-
Web Listesi
-
QR Kodum
-
Unutmayın, yukarıda listelenmeyen Etkinlik Uygulaması özelliklerini manuel olarak eklemeniz ve yapılandırmanız gerekir.
İpucu: API'de özelliklere “bileşenler” denir.
Kayıt
-
Ödeme ayarları da dahil olmak üzere Temel Bilgiler, Görünüm ve Ayarlar bilgilerini okuyun
-
Biletler, formlar, sorular, promosyon kodları oluşturun, okuyun, güncelleyin ve silin
-
Siparişler oluşturma, okuma ve güncelleme
-
Sipariş ve bilet onay e-postaları gönderin
-
Çek veya fatura siparişlerini ödenmiş olarak işaretleyin
-
Sipariş alıcı bilgilerini güncelleyin
-
Biletleri iptal edin ve iade edin
-
Promosyon kodlarını oluşturun, okuyun, güncelleyin, silin, duraklatın ve devam ettirin
-
Vergi oluşturma, okuma, güncelleme ve silme
İpucu: API'de sorulara “özel alanlar” denir.
Yerinde
-
Temel bilgileri ve Yerinde Uygulama bilgilerini okuyun ve güncelleyin
Potansiyel Müşteri Alma ve Canlı Ekran
-
Ürünün etkinlikte veya Etkinlikte yayınlanıp yayınlanmadığını okuyun
Bilmeniz Gerekenler
-
API, Etkinlik oluşturmak veya Etkinlik Uygulaması ve Yerinde gibi bir Etkinlikteki ürünleri etkinleştirmek için kullanılamaz. Geliştiriciler bir Etkinliği API ile değiştirebilmeden önce, kullanmayı düşündüğünüz her ürünü etkinleştirmeli ve her biri için gerekli temel bilgileri doldurmalısınız.
-
Ara sıra iyileştirmeler ve düzeltmelerle birlikte API'nin yeni sürümlerini yayınlayacağız. Eski sürümleri herkesin yeni sürüme geçmesi için yeterince uzun süre desteklemeye devam edeceğiz. Yeni sürümler, yaklaşan eski sürümlerin kullanımdan kaldırılması tarihleri ve resmi kullanımdan kaldırmalar hakkında e-posta güncellemeleri göndereceğiz.
-
API istekleri, kötüye kullanımı önlemek için ölçülür ve sınırlandırılır.
-
Topluluklar ayrıca Suite müşterileri için de desteklenir.
