Özel REST API

API Integration, herhangi bir REST API'yi Harmona'ya bağlar: kendi backend'iniz, bir iç servis ya da katalogda olmayan üçüncü taraf bir API. Endpoint'leri bir kez tanımlarsınız, asistanlar bir soru gerektirdiğinde onları çağırır.

Entegrasyonu oluşturun

1. 1Stüdyo → Entegrasyonlar sayfasına gidin, Entegrasyon Ekle düğmesine tıklayın ve Özel API'ler altından API Integration seçeneğini seçin.
2. 2Bir Entegrasyon Adı ve API'nin ne için olduğunu anlatan bir Açıklama girin.
3. 3Temel URL değerini girin, örneğin `https://api.example.com`.
4. 4Kimlik Doğrulama Tipi seçin: Bearer Token, API Anahtarı (Header Adı ile birlikte), Temel Kimlik Doğrulama veya Kimlik Doğrulama Yok. Ardından kimlik bilgilerini doldurun.
5. 5İsterseniz Markdown ile API Dokümantasyonu ekleyin: kurallar, ID biçimleri, örnekler. Asistanlar API'yi çağırmadan önce bunu okur.
6. 6Entegrasyon Oluştur düğmesine tıklayın. Ardından endpoint'lerini eklemek için entegrasyonu listeden açın.

Endpoint ekleyin

Endpoint Ekle düğmesine tıklayın. Endpoint'i iki şekilde tanımlayabilirsiniz.

• cURL ile İçe Aktar: endpoint'e bir Ad ve Açıklama verin, ardından çalışan bir cURL komutu yapıştırın. Harmona metodu, yolu, query parametrelerini ve gövdeyi komuttan okur ve her parametre için bir açıklama yazar. Endpoint'i çağırmaz.
• Yapısal Giriş: HTTP Metodu ve Path Template değerlerini ayarlayın, örneğin `/customers/{customer_id}/orders`. Ardından Path Parametreleri, Query Parametreleri, Request Header'ları ve Request Body Özellikleri alanlarını her biri için bir açıklama ve Zorunlu olup olmadığıyla birlikte listeleyin.

Elle eklediğiniz endpoint'ler otomatik olarak analiz edilmez. Kaydettikten sonra Harmona'nın parametre açıklamalarını yazması için Yeniden Analiz Et düğmesine tıklayın. Analiz sürerken endpoint'i düzenleyemezsiniz.

İyi açıklamalar yazın

Asistanlar endpoint'leri seçerken ve parametreleri doldururken açıklamalarınıza bakar. Her endpoint'in ne döndürdüğünü ve ne zaman kullanılacağını yazın; her parametrenin biçimini açıklayın, örneğin "10 haneli sipariş numarası". Yalnızca asistanların çağırmasını istediğiniz endpoint'leri ekleyin.

Kullanın

Entegrasyonu diğer entegrasyonlar gibi bir asistana veya Worker'a ekleyin ya da endpoint'lerini iş akışı adımlarından çağırın. Başkalarının da kullanabilmesi için Entegrasyonlar sayfasından paylaşın. Bkz. Entegrasyonlar nasıl çalışır.