API İstekleri ve Oki-Toki API Dokümantasyonu

API istekleri nedir?

API, bir programın başka bir programla “pazarlık” yapmasının bir yöntemidir. Oki-toki’ye gerekli verileri aktarmasını veya almasını isteyebilirsiniz. Örneğin, müşteri bilgilerini otomatik olarak CRM’inize göndermek veya verileri tekrar Oki-Toki’ye yüklemek gibi.

Bir çağrı merkezi için API’nin faydası nedir?

• Süreç otomasyonu: API, rutin görevleri üstlenir. Örneğin, yeni bir iletişim CRM’inize gönderilir, veriler otomatik olarak güncellenir;
• Api dış hizmet entegrasyonu : API yardımıyla, Oki-Toki’yi diğer sistemlerle – CRM, analitik, chatbotlar vb. ile kolayca bağlayabilirsiniz. Tüm araçlar bir bütün olarak çalışır, bu da iş süreçlerini daha basit ve daha hızlı hale getirir.
• Gercek zamanlı veri: sistem, bilgi geldiği gibi gönderir veya alır. Bu, analiz ve izleme için uygundur;
• Kolay ölçeklendirme: karmaşık değişiklikler olmadan yeni özellikler ve araçlar ekleyebilirsiniz. Bu, özellikle projeniz büyüyorsa rahattır;
• Hataların azaltılması: manuel iş daha az — hata yapma riski daha düşük. Her şey otomatik, hızlı ve doğru bir şekilde gerçekleşir.

Oki-Toki’deki API istek türleri

Oki-Toki, web hizmetleriyle etkileşimde standart metod olan REST API’yi kullanır. Sistem, istek üzerine bilgi alır ve genellikle JSON olmak üzere istenilen biçimde bir yanıt sağlar. Oki-Toki’de aşağıdaki istek metotları mevcuttur:

• GET – bilgi almak için kullanılır, örneğin CRM’den kişiler veya çağrı istatistikleri;
• POST – sistemde yeni veriler gönderir, örneğin toplu dialer görevleri ekleme veya kaldırma, dialeri açma/kapama.

Bir isteği test etmek, veri doğruluğunu kontrol etmek veya bir hatayı bulmak için, Postman uygundur.

Dokümantasyon ve API ayarları Oki-Toki 

Oki-Toki API dokümantasyonu çalışmayla ilgili rehberinizdir, istek metotları, kullanım örnekleri ve veri yapısını açıklar. Kolaylık olması açısından, teknik dokümantasyon Oki-Toki’nin ana fonksiyonları ve araçlarına dayanarak bölümlere ayrılmıştır.

API’ye Erişim

API’ye erişim, tokenlar kullanılarak yapılır – bunlar, sistemin kimin erişim sağladığını anlamasını sağlayan anahtarlardır. Bunlarla, API ile kolayca çalışabilir ve verileri güvenli bir şekilde aktarabilirsiniz. Oki-Toki’de, bir kullanıcı, Rolünde “Kullanıcıları yönet” hakkına sahip olduğunda kendi tokenını oluşturabilir. Bu hak varsayılan rollerde “Admin” ve “Supervisor” da mevcuttur, ancak istediğiniz herhangi bir role de ekleyebilirsiniz. 

“Harici kaynakları, entegrasyonları ve olayları (Webhook) yönetme” başka bir hak daha olup API ile çalışmak için gereklidir. Bunu olmadan, bir entegrasyon dokümanı veya Webhook eklemek mümkün olmayacaktır.

Rolleri yönetme hakkında daha fazla bilgi edinin blogumuzdaki ayrı bir makalede.

API anahtarı nasıl alınır?

Herhangi bir API isteği oluşturmak için bir tokena ihtiyacınız vardır. Bunu oluşturmak için, Kullanıcılar listesi bölümüne gidin. Profil ayarlarında “Güvenlik” öğesini seçin. Burada bir token oluşturabilir, görüntüleyebilir veya silebilirsiniz.

API istek hata kodları

Herkes hata yapabilir – hatta profesyoneller bile veri aktarımında veya görevlerin gerçekleştirilmesinde zorluklarla karşılaşabilir. Önemli olan bunu nasıl düzelteceğinizi bilmektir. API isteği yaparken en yaygın hataların bir listesini hazırladık:

• 401 (Yetkisiz) – istek, mevcut olmayan bir nesneyi belirtiyor veya tokenınız yanlış;
• 403 (Yasak) – bu, sunucunun isteği anladığı ancak erişimi reddettiği anlamına gelir. Bu isteği gerçekleştirmek için gerekli hak ve izinlere sahip olmayabilirsiniz;
• 404 (Bulunamadı) – URL bağlantısında hatalar var, girilen verilerin doğruluğunu kontrol edin;
• 405 Method Not Allowed – yanlış istek türü. Örneğin, GET yerine POST metodu kullanmaya çalıştınız;
• 422 (İşlenemeyen Varlık) – istek kabul edildi, ancak verinin “gövdesinde” semantik bir hata nedeniyle işlenmedi;
• 429 Çok Fazla İstek – istek limitinin aşılması;
• 500 (Sunucu İç Hatası)– sunucunun işleyişi ya da isteğinizin işlenmesinde sorunlar.

Her API hatası, sorunun nedenini belirlemenize ve düzeltmenize yardımcı olacak bir kod ve mesajla birlikte gelir.

Oki-Toki’de API kullanım örnekleri

Oki-Toki API, bir çağrı merkezinde birçok görevi çözmek için bir araçtır. İşte kullanımının zaman kazandırabileceği ve süreçleri basitleştirebileceği bazı örnekler:

1. Bir dialere müşteri ekleme gelen çağrılar/soğuk veri tabanını sonrasında işleme için – başarılı bir bağlantı sağlandıktan sonra, veriler daha sonraki aramalar için otomatik olarak aktarılır. Bu, zaman kazandırır ve manuel işleme dair hata riskini azaltır;
2. Bir dialerden görevleri silme – işlenmiş ve müşterilerin reddetmesi nedeniyle artık ilgili olmayan görevler dialer listesinden kaldırılacaktır;
3. CRM’ye çağrı verilerini aktarma – müşteriyle daha fazla çalışmak için gerekli olan tüm çağrı verileri CRM’e aktarılacak; 
4. CRM’de iletişim güncelleme – Örneğin, görevlerin durumunu değiştirme veya analiz için yeni parametreler ekleme.

Bir API isteği nasıl oluşturulur?

Oki-toki’de veri ile çalışmak için bir istek oluşturmak için öncelikle API dokümantasyonuyla tanışın. Burada hangi verilerin aktarılabilir veya alınabilir olduğu hakkında bilgiler toplanmıştır. Gerekli isteği seçin ve ek bilgilerin ne olabileceğini görün, örneğin dialerin ID’si. Bu veriyi bulmak için gerekli dialere gidin.

ID, tarayıcının adres çubuğundaki araç adından sonra gelen numaradır — bu, aracın numarasıdır.

Postman’de bir API isteği örneği: kara listeye ekleme

Postman programında bir istek bağlantısı formüle edeceğiz, bu program cihazınıza kurulmalıdır. Dokümantasyonda “Listeler” bölümüne bakın, “Bir listeye değer ekleme“ isteğini seçin. İstek, verileri Listelerinize ekler. Mutlaka “Kara Listeye” olmak zorunda değildir, belki “VIP müşteri listesi” veya iş süreçlerinize uygun başka bir listeyi tamamlamak istersiniz.

API bağlantısını formüle etme işlemine geçelim:

• dokümantasyonda istek türünü arayın – bizim durumumuzda bu post ve URL bağlantısını kopyalayın https://home.oki-toki.net/api/v1/lists/add. Postman’a gidin, türü belirleyin ve bağlantıyı yapıştırın.

• bir sonraki adım – tokeniniz. Token nasıl oluşturulacağını yukarıdaki makalede anlattık;
• isteğe, list ID parametresini belirtmek gerekiyor. Bunu yapmak için, Listeler bölümüne gidin, gerekli olanı bulun, adres çubuğundan numarayı kopyalayın ve Postman’a aktarın. 
• “values” parametresiyle, listeye eklenecek verileri, örneğin bir telefon numarasını, tamamlamanız gerekiyor; 

Tüm parametreleri girdikten sonra, bu formda bir bağlantı oluşturuyoruz: https://home.oki-toki.net/api/v1/lists/add?api_token=(SİZİN TOKENINIZ)list_id=101&values=(TELEFON NUMARASI)İsteği oluşturuyoruz, eğer her şey doğruysa 200 OK yanıtını alıyoruz. Şimdi gerekli numara kara listeye eklenmiştir.

İsteklerin tetiklenmesi için farklı koşullar ayarlamak amacıyla olayları kullanın. Bu, sadece çağrılar ve müşteriler hakkında veri aktarımına izin vermekle kalmaz, aynı zamanda ihlaller, kullanıcı durumları ve konuşma analitiğinin tetiklenmesi hakkında bilgiler sağlar. Bu, aracıların ana performans göstergelerini, aktivitelerini, scriptlerden sapmaları veya disiplin ihlallerini kaydetmeyi ve böylece hizmet kalitesinin yüksek düzeylerde tutulmasını sağlar.

API entegrasyonu nasıl kurulur?

Bir dış kaynakla Oki-Toki’yi bağlamanız gerekiyorsa, entegrasyon API yardımcı olabilir. Örneğin, müşteri verilerini aktarmak veya bir numarayı dialere eklemek, API aracılığıyla otomatik hale getirilebilir. Ayarlar iki aşamadan oluşmaktadır:

Aşama 1. Bir webhook oluşturma

Öncelikle, webhook‘u Dış kaynaklar bölümünde oluşturmanız gerekir:

• İsmini belirtin;
• URL satırında, elinizdeki göreve bağlı olarak bağlantıyı aktarın. Örneğin, bir görevi dialere eklemek için, teknik dokümantasyonda “Bir arama (numara) için görev ekleme”  API isteğini bulun, bağlantıyı kopyalayın ve URL satırına yapıştırın;
• Veri aktarımı yöntemini listeden seçin: GET, POST, JSON;
• “Genel istek parametreleri” satırına, api_token= SİZİN TOKENINIZ formatında erişim anahtarınızı girin.

Örnek, Oki-Toki içindeki görevleri otomatikleştirmek için bir webhook oluşturma işlemini gösterir. URL satırında bir dış sisteme bağlantı belirtilirse, o zaman oki-toki onunla entegre olacaktır. Blogumuzda Telegram ile chatbot entegrasyonunu nasıl yapacağınızı okuyun.

Aşama 2. Bir olay oluşturma

Olaylar ve Entegrasyonlar bölümüne gidin ve yeni bir bağlama oluşturun.

• İsim ve olay türünü (kullanıcı eylemleri, çağrılar, ihlaller) belirtin;
• Dış entegrasyon – listeden seçin veya yeni bir dış kaynak ekleyin;
• Tetikleyici koşullar – olayın gerçekleşmesi için bir tetikleyici ayarlayın. Koşullar listesi, olayın türüne bağlıdır;

• Eylem parametreleri – bu satırda, isteği detaylandıracak veriler yer almalıdır. İstekte kullanılabilecek mevcut parametreler, dokümantasyonda belirtilmiştir;
• Değişkenler listelenir. Gereken birine tıklayarak, eylem parametrelerini doldurmak için kopyalanması sağlanır. 

API istekleri için raporlama ve maliyetler

İsteklerin nasıl gerçekleştirildiğini kullanarak API çağrı günlüğü izleyebilirsiniz. Rapor, tarih, kullanıcılar, uygulama süresi ve istek türüne göre oluşturulur – API’yi seçin. Hazır rapor, isteği oluşturan kullanıcının adı, tarih, saat, süre, URL ve istek parametreleri hakkında bilgiler içerir. Veriler HTML, Google Sheets ve Microsoft Excel formatlarında dışa aktarılabilir.

Hangi olayların işlendiği ve ne sonuçla olduğu bilgisine Olay günlüğünde ulaşabilirsiniz. Rapor, adı, olay türü, entegrasyon, oluşturma ve işlenme tarihi, mevcut durumu (başarılı, başarısız veya bekleyen) ve API kullanılarak olaylar ve entegrasyonların oluşturulması sırasında dahil edilen verileri içerir.

API istekleri – ücretli bir özellik, maliyet hakkında bilgiyi Hizmet Yönetimi bölümünde bulabilirsiniz. Günlük borçlandırmalarınızı Bakiye Günlüğünde rahatça takip edebilirsiniz.

Bu rehberi takip ederek ve Oki-Toki’nin dokümantasyonunu kullanarak, veri aktarımı ve API istekleri ayarlayabilirsiniz. Oki-Toki’den entegrasyonlar ve webhooks, çoğu pratik görevi hızlı, etkili ve ekstra çaba harcamadan çözecektir. Bu, şirketinizin birçok iş sürecini optimize edecek ve sizin ana konu üzerinde — müşterilerle kaliteli çalışmak üzerinde odaklanmanızı sağlayacaktır.