Vivollo

REST API

Vivollo verilerinizi programatik olarak okuyun ve yönetin — sohbetler, koleksiyonlar, akışlar ve daha fazlası — sade bir REST API üzerinden.

Kodunuzun Vivollo'ya uzanması gerektiğinde — sohbetleri okumak, bilginizi yönetmek ya da verileri kendi sistemlerinize eşitlemek için — REST API'yi kullanırsınız. Bu, çalışma alanınıza açılan programatik kapıdır ve bir API anahtarı ile kimlik doğrulanır.

Sıradan bir REST API'dir: öngörülebilir URL'ler, standart HTTP yöntemleri ve girişte de çıkışta da JSON. Modern web API'lerinden herhangi biriyle çalıştıysanız, kendinizi hemen evinizde hissedersiniz.

Kimlik doğrulama

Her istek, API anahtarınızı bir bearer token olarak taşır:

Authorization: Bearer YOUR_API_KEY

Anahtar, her isteği yalnızca sizin çalışma alanınızla sınırlar — yalnızca kendi verilerinizi okuyup değiştirebilirsiniz, başka bir müşterininkini asla.

Neler üzerinde çalışabilirsiniz

API, çalışma alanınızın özünü REST kaynakları olarak sunar; şunlar dahil:

  • Sohbetler ve mesajlar — asistanınızın ve ekibinizin yürüttüğü konuşma akışlarını ve içlerindeki mesajları okuyun.
  • Koleksiyonlar ve belgeler — bilginizi yönetin: koleksiyonlar oluşturun, belge ekleyin ya da çıkarın.
  • Akışlar ve asistanlar — asistanınızın yapı taşları.
  • Insights — sohbetlerinizin sınıflandırılmış, çözümlenmiş görünümü: segmentler, dökümler ve eğilimler.

Kaynaklar her zamanki REST biçimini izler — listelemek ve okumak için GET, oluşturmak için POST, güncellemek için PUT/PATCH, silmek için DELETE — ve listeleme uç noktaları sayfalanmıştır.

İçeri bilgi göndermek

API'nin yaygın kullanımlarından biri, asistanınızı kendi sistemlerinizdeki bilgilerle beslemektir — özellikle içeriğiniz Vivollo'nun kutudan çıktığı gibi bağlanamadığı bir yerde duruyorsa pek işe yarar (bkz. İçerik ekleme). Tam da bunun için bir toplu belge (bulk document) uç noktası vardır: bir grup belgeyi tek bir çağrıyla bir koleksiyona gönderir ve aynı yolla çıkarırsınız. CMS'iniz ya da arka ucunuz, içeriğiniz değiştikçe bir koleksiyonu eşitlenmiş tutabilir.

Başlarken

Yol kısa:

  1. Bir API anahtarı oluşturun.
  2. Anahtarı Authorization başlığına koyarak Vivollo API'sine istek gönderin.
  3. İhtiyacınız olanı okuyun ya da koleksiyonlarınıza belge gönderin.

Sohbetin çevresinde değil de içinde, canlı bir konuşma sırasında hareket etmek için genellikle REST API'ye hiç ihtiyacınız olmaz — kod gerektirmeyen API Çağrısı eylemi, bir akışın sohbetin tam ortasında sistemlerinize uzanmasını sağlar. Vivollo'nun çevresinde bir entegrasyon yaparken (eşitleme, raporlama, toplu bilgi) REST API'ye; bir sohbetin içinde entegre olurken API Çağrısı eylemine uzanın.

Webhook'larla eşlemek

REST API ile webhook'lar doğal bir ikilidir. Webhook size bir şey olduğunu söyler; API ise bildirim tek başına yetmediğinde tüm resmi çekmenizi sağlar. Yaygın bir kalıp:

conversation.updated webhook'u tetiklenir → kodunuz API'yi çağırıp sohbetin tamamını çeker → siz de bunu kendi sisteminizde işlersiniz.

Bir API anahtarı oluşturarak başlayın — buradaki her şeyin giriş kapısı odur.