Ana içeriğe geç

Geliştirici API'si ve webhook'lar

Geliştirici Merkezi'nden API anahtarları oluşturun, webhook uç noktalarını kaydedin ve istek günlüklerini inceleyin.

Yazar: Sarah Chen

Geliştirici Merkezi, Exayard'ı kendi kodunuza ve araçlarınıza bağladığınız yerdir. Onu Ayarlar'dan, ardından Geliştirici'den açın. Buradan API anahtarları oluşturur, web kancası uç noktaları kaydeder ve her API isteğinin canlı bir günlüğünü incelersiniz. Bu sayfaya yalnızca organizasyon yöneticileri erişebilir.

API anahtarları

Bir API anahtarı, Exayard API'sine yapılan istekleri doğrular. Anahtarlar organizasyonunuza aittir; böylece doğru hesap otomatik olarak seçilir ve geçirilecek bir organizasyon kimliği olmaz.

Kimlik bilgileri kartındaki API anahtarları sekmesini açın ve + düğmesine tıklayın. Anahtara bir Ad verin, ardından Kapsamlarını seçin. Her kapsamı vermek için Tümü'nü, tek tek izinleri seçmek için Belirli'yi seçin. Kapsamlar, read:projects ve write:estimates gibi kaynak başına bir okuma ve yazma ayrımını izler. admin:org kapsamı, tam erişim hakkıdır. Entegrasyonunuzun ihtiyaç duyduğu en az kapsamı seçin.

Exayard, tam anahtarı oluşturduktan hemen sonra bir kez gösterir. O sırada kopyalayın; çünkü bir daha asla gösterilmez. Bundan sonra her anahtar; adı, ak_••••1234 gibi maskelenmiş bir önizleme ve en son kullanıldığı tarih ile birlikte görünür.

Bir anahtarı yeniden adlandırmak veya kapsamlarını değiştirmek için kalem simgesini kullanın. Onu İptal etmek için çöp kutusu simgesini kullanın. İptal etmek kalıcıdır ve o anahtarı kullanan herhangi bir entegrasyon hemen çalışmayı durdurur.

Aynı anahtar, kodsuz entegrasyonların kimliğini de doğrular. Exayard'ı Zapier'a bağlama, Exayard'ı Make'e bağlama ve Exayard'ı n8n'e bağlama sayfalarına bakın. Aracı ve yapay zekâ düzenleyicisi erişimi için Claude ve diğer yapay zekâ araçlarına bağlanma sayfasına bakın.

Web kancaları

Bir web kancası, bir şey gerçekleştiğinde Exayard'a sunucunuzu bilgilendirmesini söyler. Web kancaları sekmesini açın ve bir uç nokta eklemek için + düğmesine tıklayın. Teslimatları alması gereken URL'yi ve isteğe bağlı bir Açıklama girin.

Hangi Olaylara abone olacağınızı seçin. Her olayı almak için Tümü'nü, listeden seçim yapmak için Belirli'yi seçin:

Olay

Tetiklenme zamanı

project.created

Bir proje oluşturulduğunda

project.updated

Bir proje değiştirildiğinde

project.archived

Bir proje arşivlendiğinde

assessment.started

Bir metraj değerlendirmesi başladığında

assessment.completed

Bir değerlendirme tamamlandığında

assessment.approved

Bir değerlendirme onaylandığında

assessment.cancelled

Bir değerlendirme iptal edildiğinde

estimate.generated

Bir tahmin oluşturulduğunda

bid.generated

Bir teklif oluşturulduğunda

file.processed

Yüklenen bir dosyanın işlenmesi tamamlandığında

Bir uç nokta oluşturduğunuzda, Exayard bir imzalama gizli anahtarını bir kez gösterir. O sırada kopyalayın; çünkü bir daha gösterilmez.

Web kancası teslimatlarını güvenli hâle getirme

Her teslimat, t=<unix>,v1=<digest> biçiminde bir Exayard-Signature üst bilgisi taşır. Exayard, imzayı zaman damgasını ve istek gövdesini birleştirerek ve ardından bunları uç nokta gizli anahtarınızla HMAC-SHA256 kullanarak imzalayarak oluşturur.

Bir teslimatı doğrulamak için imzayı gizli anahtarınızla yeniden hesaplayın, zaman damgasının şu andan itibaren beş dakika içinde olduğunu doğrulayın ve özetleri karşılaştırın. Başarısız teslimatlar, yaklaşık üç gün boyunca üstel geri çekilme ile yeniden denenir.

Bir uç noktayı düzenlemek için kalem simgesine tıklayın. URL'yi, açıklamayı ve olayları değiştirebilir ve Durumunu Etkin veya Duraklatıldı olarak ayarlayabilirsiniz. Duraklatılan uç noktalar teslimat almayı durdurur. Aynı iletişim kutusunda bir Gizli anahtarı döndür düğmesi vardır. Döndürmek yeni bir gizli anahtar verir ve eskisi hemen çalışmayı durdurur; bu nedenle döndürmeden önce sunucunuzu güncelleyin. Çöp kutusu simgesi bir uç noktayı siler ve ona yapılan tüm teslimatları sonlandırır.

Hızlı başlangıç

Hızlı başlangıç kartı, Claude veya Cursor gibi bir yapay zekâ düzenleyicisi için hazır bir istem içerir. İstemi kopyala'ya tıklayın ve onu düzenleyicinize yapıştırın. İstem; API temel URL'sini, kimlik doğrulama biçimini, kapsam söz dağarcığını ve web kancası imzalama düzenini içerir; böylece yapay zekâ çalışan bir entegrasyonu iskeletleyebilir ve ihtiyaç duyduğu ayrıntıları sizden isteyebilir.

Belgeler

Belgeler kartı, tam geliştirici belgelerine ve her rotayı ve şemayı tanımlayan OpenAPI belirtimine bağlanır. MCP'ye bağlan, yapay zekâ aracılarını doğrudan Exayard'a bağlamak için kurulumu açar.

Günlükler

Günlükler bölümü, hem REST API hem de MCP genelinde en son API isteklerinizi kaydeder. Her satır; yöntemi, yolu, yanıt durumunu ve gecikmeyi gösterir. İstek kimliği ile istek ve yanıt gövdeleri dâhil tüm ayrıntılarını görmek için bir satır seçin. Bir çağrının çalışıp çalışmadığını doğrulamak veya başarısız bir entegrasyonda hata ayıklamak için günlükleri kullanın.

Bu cevap sorunuzu yanıtladı mı?