Skip to main content
Genel API, Failproof AI kontrol paneli kaynağında /v1 altında sunulur.

Anahtar oluşturun ve istek gönderin

  1. Administration → Keys bölümünü açın, Create key seçeneğini tıklayın ve entegrasyon için gerekli olan en dar izin ön ayarını seçin.
  2. Bireysel yetkiler yalnızca gerektiğinde ekleyin, anahtarı oluşturun ve tek seferlik sırrını kopyalayın.
  3. /v1/sessions adresine test isteği gönderin ve anahtarın Keys sayfasında aktif kaldığını doğrulayın.
  4. Entegrasyon sahipliği değiştiğinde anahtarı kendi eylem menüsünden döndürün veya devre dışı bırakın. Yeni API anahtarı çekmecesi, izin ön ayarları ve bireysel yetkilerle.
Yukarıda oluşturma çekmecesi gösterilmektedir. Tek seferlik sıfır yalnızca create seçtikten sonra görünür; bu onay penceresi kapanmadan önce kopyalayın.
Anahtarlar bir kuruluş ve izin seti kapsamındadır. Endpoint’in gerekli iznine sahip olmayan bir istek 403 döndürür ve eksik izni belirtir.

Kuruluş seçimi

Bir kuruluş anahtarı kuruluş üzerinde otomatik olarak çalışır. Örnek kapsamlı bir anahtar istek başına bir kuruluş seçebilir:
Dashboard başlığında kuruluş değiştiricisini kullanın ve Administration → Keys bölümünü açmadan önce seçilmiş kuruluşa ait anahtarları oluşturun. URL’deki kuruluş slug’ını ve kimlik bilgisini otomasyon ortamına kopyalamadan önce anahtar ayrıntılarından doğrulayın.
Geçerli yollar, parametreler, izin gereksinimleri ve durum kodları için bu bölümdeki oluşturulan endpoint sayfalarını kullanın. Belirtim sunucu yolu ek açıklamalarından oluşturulur ve /v1 yönlendiricisine karşı denetlenir. Mevcut belirtim tam rota, yöntem, parametre, izin ve durum kodu kapsamasına sahiptir. Sunucu bunları dinamik JSON olarak oluşturmaya devam ettiği için bazı yanıt gövdeleri kasten yazılmamıştır. Yanıt şeması olmayan bir endpoint etrafında kesin bir şekilde yazılı istemci oluşturmadan önce gerçek bir yanıtı inceleyin. JSON yazmaları için Content-Type: application/json kullanın. 401 değerini eksik veya geçersiz kimlik doğrulaması, 403 değerini gerekli izne sahip olmayan geçerli kimlik, 404 değerini eksik veya kuruluşa erişilemeyen kaynak, 409 değerini durum çatışması ve 422 değerini geçersiz alan veya izin değeri olarak değerlendirin. Hata yanıtları insan tarafından okunabilir bir mesaj içerir; izin hataları gerekli yetkiyi de adlandırır.
İlke uygulanması dağıtımı kasıtlı olarak olağan genel /v1 yüzeyi dışında yönetilir. Desteklenen Cloud dağıtım iş akışını kullanın.