API, Uygulama Programlama Arayüzü anlamına gelir. Belirli bir işleve sahip herhangi bir yazılım, API'ler tartışılırken uygulama olarak adlandırılır. API arabirimini, istekleri ve yanıtları belirten iki program arasındaki bir hizmet sözleşmesiyle karşılaştırabilirsiniz. API'lerde yeniyseniz, kontrol etmenizi öneririz. API'lere Yeni Başlayanlar Kılavuzu hem de REST API'lerine Genel Bakış Bunu okumadan önce blog.
REST API'leri HTTP/HTTPS protokolü aracılığıyla CRM verilerine erişmenizi sağlar. Herhangi bir CRM kayıt bilgisi üzerinde oluşturma, güncelleme, alma veya silme işlemleri yapabilirsiniz. Ayrıca uzantıya özgü ve kullanıcıya özel yapılandırma verilerini saklamanıza veya depolanan uzantıya özgü verileri kullanarak harici uygulamalara bağlanmanıza olanak tanır. Tüm bu verilere, temel yetkilendirme kullanılarak, yani kullanıcı adı ve erişim anahtarı kullanılarak erişilebilir.
REST API oluşturma
Herhangi bir API oluşturmak için kullanabileceğiniz beş genel adım aşağıda verilmiştir:
- API'yi planlayın: API'nizi tasarlama yönergeleri, OpenAPI gibi API özellikleri tarafından sağlanır. Çeşitli kullanım durumlarını önceden değerlendirmek ve API'nin mevcut API geliştirme standartlarına uygun olmasını sağlamak tercih edilir.
- API'yi oluşturun: API tasarımcıları, mevcut API'lerde çok az değişiklik yaparak yeni API'lerin prototiplerini oluşturur. Geliştiriciler, testten geçtikten sonra prototipi dahili gereksinimlere uyarlayabilir.
- API'yi test edin: Yazılım testine benzer şekilde, hatalara ve kusurlara karşı korunmak için API testi gereklidir. API testi için araçları kullanarak API'nin çevrimiçi saldırılara karşı gücünü test edin.
- API'yi belgeleyin: API'ler kendi kendini açıklayıcı olsa da, belgeler kullanıcılara daha kolay yardımcı olabilir. Hizmet odaklı bir mimaride, çeşitli işlevlere ve kullanım durumlarına sahip, iyi belgelenmiş API'ler daha sık kullanılır. Yön vermek ve başkalarının kendi API'lerini oluşturmasına yardımcı olmak için bir yardım belgesi yazın.
- API'yi pazarlayın: Tıpkı eBay, Amazon ve Flipkart'ta perakende ürünler için olduğu gibi, geliştiricilerin API'leri alıp başkalarına satabilecekleri çevrimiçi pazar yerleri vardır. API'nizi listeleyerek para kazanabilirsiniz.
Bu blog size Vtiger'in API Designer'ını kullanarak özel bir REST API komutunun nasıl oluşturulacağını öğretecek. Öyleyse başlayalım.
API Tasarımcısı nedir?
API Tasarımcısı, geliştiricilerin özel web hizmeti API'leri oluşturmak için kullanabilecekleri bir araç veya uygulamadır. Özel hizmet uç noktalarınızı ve sorgu parametrelerinizi tanımlayabilirsiniz. Bu API'ler, CRM verileriyle etkileşimde bulunmak, harici uygulamalarla entegre olmak ve ayrıca bu verileri Vtiger UI'deki özel sayfalarda veya widget'larda kullanılmak üzere VTAP Javascript API'lerine maruz bırakmak için kullanılabilir.
Vtiger Uygulama Tasarım Dilini kullanarak API'ler oluşturabilirsiniz (VADL), genel olarak XML sözdizimine dayalıdır. VADL, üst düzey programlama becerilerine sahip olmayan yöneticilerin veya geliştiricilerin API'leri kolayca tanımlamasına olanak tanır, ancak temel bir programlama anlayışı ile hızlı bir şekilde etkili API'ler oluşturabilirsiniz.
REST API'leri standart REST API protokolünü izler ve uç noktalarını aşağıdaki gibi tanımlayabilirsiniz:
| https://instance.odx.vtiger.com/restapi/vtap/api/YOUR_CUSTOM_API_PATH |
|---|
REST API için aşağıdaki HTTP istek yöntemleri desteklenir:
- GET
- POST
- PUT
- SİL
Özel REST API'nizi oluşturmak için VTAP'ı nasıl kullanabileceğinizi görelim.
Vtiger CRM kullanıcıları, CRM'yi diğer üçüncü taraf uygulamalara bağlayacak veya CRM'nin işlevselliğini genişletecek yenilerini oluşturacak REST API'leri oluşturabilir. İşte bir örnek:
yapabilen bir REST API oluşturalım. şuradan verilere erişin: belirli modül VTAP'ı kullanarak.
Aşağıda bunun bir örneği Verileri alan API adlı CRM modülünden Organizasyonlar API adıyla en yüksek yıllık gelire sahip ilk beş kuruluşu şu şekilde görüntülemek için: en iyi_organizasyonlar. Benzersiz tutmak için farklı bir adla gidebilirsiniz.
Başlamadan önce, yukarıdaki API örneğinin eylemlerini tanımlamak için kullanılacak olan XML ve VDAL bileşenlerini anlayalım.
Aşağıdaki tabloda, CRM verilerine erişmek ve bunları görüntülemek için özel REST API'sini tanımlamak üzere kullanılacak XML ve VDAL bileşenleri açıklanmaktadır:
| XML ve VDAL Bileşeni | Action |
|---|---|
| api yöntemi = ”al” | HTTP İstek yöntemini tanımlama |
| modül seç = ”Hesaplar” | Kullanarak veri almak için modülü tanımlayın seçmek |
| kayıt alan adı = ”hesap adı”> | Kullanarak verileri almak için kayıttaki alanları tanımlayın. kayıt |
| tür alan adı=”annual_revenue” order=”azalan” /alan /düzenlemek |
Kullanarak tablo sonucunun koşullarını tanımlayın tür |
| limit maks=”5″ sayfa=”@sayfa” /limit | Kullanılarak görüntülenecek kayıt ayrıntılarının sayısını tanımlayın. sınır |
| /seçme /api |
Tüm açık etiketleri kapatarak bitirin |
not yukarıdaki tablodaki tüm XML ve VDAL bileşenlerinin etiketlerle (<>) çevrelenmesi gerektiğini.
Yukarıda tartışılan REST API'sini oluşturmak için şu adımları izleyin:
- Vtiger CRM hesabınızda oturum açın.
- Tıkla Ana menü.
- Tıkla Platform.
- Seç API Tasarımcısı.
- Tıkla +API ekle.
- Tıkla Oluştur REST API'nin yanında. REST API Ekle penceresi açılır.
- REST API'si ekle: Aşağıdakiler için bilgi girin veya seçin:
- modül: Verilere erişilmesi gereken CRM modülünü seçin.
- İsim: API için benzersiz bir tanımlayıcı girin.
- Durum: API'yi etkinleştirmek için Onay Kutusunu tıklayın.
- Tıkla İndirim.
- API'yi ekledikten sonra, API'leri tanımlamak için VADL'yi ve CRM verilerini almak için XML düğümlerini kullanacağınız yerleşik bir IDE göreceksiniz. XML ve VADL bileşenlerini anlamak için yukarıdaki tabloya bakın.
- Tıkla Kaydet ve Yayınla yerleşik API'yi yayınlamak için.
Aşağıdaki URL'yi kullanarak herhangi bir harici uygulamadan yukarıdaki REST API'ye erişebilir ve test edebilirsiniz.
| https://instance.odx.vtiger.com/restapi/vtap/api/top_organizations |
|---|
not yukarıdaki URL'nin bir örnek olduğunu ve uç noktayı CRM örneğinize göre tanımlamanız gerekeceğini.
Bunları biliyor muydunuz?
Yukarıdaki veriler, özel bir sayfada bir liste olarak göstermek için kullanılabilir veya API'lerinizi tanımlamak için javascript bileşenlerini kullanan bir çubuk grafik ve diğer dinamik sonuçlar için kullanılabilir. API Designer'da yerleşik olan tüm özel REST API'lerine şu şekilde erişilebilir: VTAP Javascript API'leri.
Özel API'ler ve VTAP oluşturma hakkında daha fazla bilgi için göz atın VTAP Dokümantasyonu.
