API ve webhook başvurusu

Oturumlu aksiyon çağrılarını ve imzalı olay teslimatlarını anla.

Bu bölüm uygulama kodunda bulunan kapıları açıklar. Dağıtım yapmaz ve bütün iç API'ları kararlı, herkese açık bir ürün API'sı olarak sunmaz. Kodsuz yönetim için Gelişmiş ayarlar.

Başlamadan önce

Tarayıcı oturum kapıları ile API anahtarları aynı kimlik doğrulama değildir. Her rotanın gereğini kontrol et.

Katalog ve aksiyon çağrısı

GET /api/os/tools oturum açmış kişinin çalışma alanında izinli aksiyonları, giriş şemalarını ve olay tetikleyicilerini döndürür. ?localized=1 ekran için çevrilmiş katalog verir; otomasyon İngilizce sözleşme adlarını kullanır.

POST /api/os/actions/<action> aynı tarayıcı oturumuyla katalogdaki tam aksiyon adını alır. JSON gövdesi aksiyonun parametreleridir; sonuç ok, result, activity özetleri ve events adları içerir. Örneğin katalogda izinliyse crm.update_lead girdisini önce katalogdan öğrenip gönder. Buradaki route getSession() kullanır; Ayarlar'da oluşturulmuş bir API anahtarını bütün bu tarayıcı kapılarına Bearer olarak eklemenin çalışacağı belgelenmiş değildir.

HTTPAnlam
401Oturum yok.
404Bilinmeyen aksiyon veya modül kapalı.
403Gerekli yetki yok.
422Girdi şemaya uymuyor.
409İş önkoşulu reddetti.
500Sunucu hatası; başarı kabul etme.

Ekrandan işlem ve Era MCP/CLI çağrıları aynı aksiyon çalışma zamanı kurallarını kullanır. MCP araçları, komutlar.

Gelen webhook

/settings/webhooks içinden gelen uç oluştur; gösterilen adres /api/webhooks/trigger/<path>. POST, JSON gövde ve Authorization: Bearer <token> veya x-era-token gerekir. Token oluşturma/döndürmede gösterilir. Tek işlem için sabit benzersiz Idempotency-Key kullan; OS kapısında tekrar koruması yedi gündür. Gövde sınırı 256 KiB. Bu sınır iş akışı motorunun diğer sağlayıcı webhook yollarını aynı şekilde sınırlandırdığı anlamına gelmez.

POST /api/webhooks/trigger/DEMO_PATH
Authorization: Bearer DEMO_TOKEN
Idempotency-Key: demo-order-001
Content-Type: application/json

{"orderReference":"demo-001"}

Gerçek token örneğe konmaz. 202 kabul edildi/olay kimliği; 200 yinelenen; 401 yanlış token; 429 hız sınırı; 410 kapalı uç; 413 büyük gövde. Kabul platform.webhook_received olayını üretir; iş akışının başarıyla tamamlandığını garanti etmez. Çalışma geçmişini ayrıca kontrol et.

Giden webhook

Uç olayları dinler ve kuyruğa teslimat koyar. Alıcı x-era-signature değerini doğrulamalıdır: t=… ,v1=… içindeki timestamp ve HMAC-SHA256. İmzalanan veri timestamp + nokta + ham gövde; JSON'u tekrar biçimlendirerek imza doğrulama. Beş dakikadan eski zamanları reddet. Idempotency-Key yeniden denemelerde aynı kalır.

Zaman aşımı/deneme/failure otomatik kapanma ve anahtar döndürme ayarları Gelişmiş altında. İmzasız eski uç listede uyarıyla görünebilir; ekrandaki İmzalı durumunu kontrol et. Test gönder gerçek teslimat kuyruğu ve geçmişini kullanır.

Diğer kapılar ve sırlar

Takvim/not tutucu ve ses servisleri kendi doğrulanan webhook'larını kullanır; adresi ilgili ayar ekranından al. İç Station, servis ve workflow API'ları bu oturum kapısından farklı kimlik doğrulamalarına sahiptir. Bunları sırf depoda route bulundu diye genel entegrasyon olarak çağırma. API ve sağlayıcı sırlarını sohbet, belge, Git veya ekran görüntüsüne koyma.

API ve webhook başvurusu
API ve webhook başvurusu