Connector Studio
Bir HTTPS API'yi sohbette anlatın; agent'ınız onu şirketinize özel, gerçek cevaplarla denenmiş ve sürümlü bir yeteneğe dönüştürsün. Her yazma işlemi onayınızı bekler.
Bu rehberde sırasıyla Connector Studio ne işe yarar, Neler yapabilir, Nasıl kullanılır, Anahtarlar ve onaylar ve Bilmeniz gerekenler konularını ele alıyoruz.
Connector Studio ne işe yarar
Connector Studio, hazır yeteneği olmayan bir API'ye agent'ınızın bağlanmasını sağlar. Hangi servise ulaşmak ve ona ne sormak istediğinizi söylersiniz; agent bir connector taslağı hazırlar, gerçek API'de dener, dönen cevabı size gösterir. Beğendiğinizde connector'ı şirketinize özel bir yetenek olarak etkinleştirir.
Kod yazılmaz, deploy edilmez. Connector, API'nin kısa bir tarifidir (adres, giriş yöntemi ve en fazla 12 çağrı) ve onu Botonom'un kendi gateway'i çalıştırır. Sohbette kurulabilmesi, sohbette değiştirilip geri alınabilmesi bundandır.
Neler yapabilir
- Sohbetle connector kurar. API'yi söyleyin, istediğiniz çağrıları anlatın; agent yolu, sorgu ve başlık parametrelerini, yazma çağrılarında da JSON gövdesini yazar.
- Açmadan önce dener. Taslaktaki her çağrı canlı API'de denenebilir; ekibiniz kullanmadan önce gerçek cevabı görürsünüz.
- OpenAPI dosyasından başlar. Agent'a bir OpenAPI 3 (JSON) tanımının adresini verin, oradan çağrı önersin. Hangilerinin ekleneceğini siz seçersiniz.
- Okur ve yazar. GET çağrıları hemen çalışır. POST, PUT, PATCH ve DELETE çağrılarının her biri önce durur, gideceği adresi ve göndereceği veriyi gösterip size sorar ve onayınızdan sonra bir kez çalışır.
- Sürüm ve geri alma. Connector her etkinleştirildiğinde bir sürüm dondurulur. Bir değişiklik işi bozarsa agent önceki sürüme döner.
- Başka agent'lara kurar. Etkin bir connector şirketinizdeki her agent'a eklenebilir.
Nasıl kullanılır
1. Kurun. Yetenek Mağazası'nda Connector Studio'yu bulun ve connector kuracak agent'a ekleyin.
2. API'yi anlatın. Agent'la normal dilde konuşun:
Kullanıcı: Frankfurter API'den döviz kurlarını okumak istiyorum. Adres https://api.frankfurter.dev/v1.
Agent: Tek çağrılık bir connector taslağı hazırladım: latest_rates (GET /latest, parametreler: base, symbols). base=EUR ile deneyeyim mi?
Kullanıcı: Evet, dene.
Agent: Çalışıyor: API euronun bugünkü kurunu 30 para birimi için döndürdü. Bu agent için etkinleştireyim mi?
Kullanıcı: Etkinleştir, Julia'ya da ekle.
Agent: Tamam. "Frankfurter Kurları" v1 iki agent'ta da etkin.
3. API anahtar istiyorsa ekleyin. Connector bir API anahtarı, bearer token, kullanıcı adı ve parola ya da OAuth2 client ID ve secret kullanıyorsa agent size paneldeki yetenek ayarlarının bağlantısını verir. Anahtarı sohbete değil oraya yazın.
Anahtarlar ve onaylar
- Anahtarlar sohbetten geçmez. Panelde girilir, şifreli saklanır ve isteğe gateway tarafından eklenir. Agent anahtarı hiç görmez; API anahtarı cevapta geri dönerse, agent görmeden önce cevaptan silinir.
- Her yazma işlemi önce sorar. POST, PUT, PATCH ve DELETE çağrılarını agent kendi başına çalıştıramaz. Gideceği adresi ve gönderilecek veriyi gösteren bir onay isteği alırsınız. Onaylarsanız bir kez çalışır, reddederseniz hiçbir şey gitmez.
- Şirketinize özel. Connector'ları yalnız şirketinizin agent'ları görür. Mağazada listelenmezler.
Bilmeniz gerekenler
- Yalnız herkese açık HTTPS API'ler. Adres 443 portunda
httpsolmalı ve açık internete çözülmeli. Özel ağlar, yerel adresler ve doğrudan IP ile yazılan adresler hem sizin hem bizim güvenliğimiz için reddedilir. - JSON gider, JSON gelir. Çağrılar JSON gövde gönderir, JSON (ya da düz metin) cevap okur. Uzun listeler 50 kayda kısaltılır, 1 MB'ı aşan cevap reddedilir.
- Giriş yöntemleri. Girişsiz, bearer token, API anahtarı (başlıkta ya da sorguda), basic auth ve OAuth2 client credentials (token'a çevrilen client ID ve secret). Giriş sayfası açan akışlar ise desteklenmez.
- Connector başına en fazla 12 çağrı. Büyük bir API için birden fazla connector kurun.
- Yönlendirme izlenmez. API yönlendirme ile cevap veriyorsa son adresi temel adres olarak kullanın.