Brandop'un teknik yapısı.

    Veri modeli, kimlik doğrulama, hız sınırları, hatalar ve servis kuralları.

    Verinin düzeni

    Her çalışma alanı tek bir web sitesidir ve tek bir alan adı vardır. Sayfalar, şemalar, işler ve taramalar çalışma alanına bağlıdır. Bir API anahtarı yalnız bir çalışma alanını açar.

    Çalışma alanı
    Tek bir site. Üyelerin rolü sahip, yönetici veya üyedir.
    Sayfa
    Çalışma alanı alan adındaki bir URL yolu, örneğin /pricing. isSelectedForSchema alanı, API'nin bu sayfa için şema verip vermeyeceğini belirler.
    Şema sürümü
    Her üretim yeni bir JSON-LD sürümü kaydeder. Şemayı panelde düzenlerseniz API sizin düzenlemenizi verir.
    İş (job)
    Arka plandaki işlem, örneğin crawl_page veya generate_schema. Durum pending, processing, completed, failed veya cancelled olur.

    Kimlik doğrulama

    API anahtarını Authorization başlığında Bearer şemasıyla gönderin.

    HTTP
    Authorization: Bearer YOUR_API_KEY
    • Anahtarlar sk_ ile başlar ve 51 karakterdir.
    • Brandop anahtarın yalnız SHA-256 özetini saklar. Tam anahtar yalnız oluşturduğunuz anda bir kez görünür.
    • Anahtarları sahipler ve yöneticiler oluşturur ve siler: Ayarlar, sonra Entegrasyonlar, sonra API Anahtarları.
    • Bir çalışma alanında en çok 5 anahtar olabilir.
    Anahtarı sunucunuzda tutun. Tarayıcı koduna veya herkese açık bir depoya koymayın.

    Plana göre API erişimi

    API erişimi bir plan özelliğidir. Tablo varsayılan plan ayarlarını gösterir.

    PlanAPI erişimiDakikada istek
    StarterVar60
    ProDahil değilDahil değil
    AgencyVar1.000
    EnterpriseVarSözleşmenizde belirlenir

    X-RateLimit-Limit başlığı çalışma alanınızın limitini gösterir. API erişimi yoksa GET /schema 403, diğer uç noktalar 401 döndürür.

    Hız sınırları

    Limit, istekleri çalışma alanı başına bir dakikalık kayan pencerede sayar. Bir çalışma alanının bütün anahtarları tek sayacı paylaşır.

    BaşlıkAçıklama
    X-RateLimit-LimitDakikada izin verilen istek sayısı.
    X-RateLimit-RemainingGeçerli pencerede kalan istek sayısı.
    X-RateLimit-ResetEn eski isteğin pencereden çıkacağı zaman (saniye cinsinden Unix zamanı).

    Çalışma alanının limiti yoksa X-RateLimit-Limit ve X-RateLimit-Remaining değeri unlimited olur. X-RateLimit-Reset gönderilmez.

    Limit aşılınca API aynı başlıklarla 429 döndürür. Sıfırlanma zamanını bekleyin, sonra yeniden deneyin.

    Hatalar

    Hata yanıtı error mesajı içeren bir JSON'dur. Bazı hatalarda ayrıca code alanı vardır.

    JSON
    {
      "error": "Page is not selected for schema delivery",
      "code": "PAGE_NOT_SELECTED"
    }
    KodNe zaman
    200Başarılı. Sayfanın henüz şeması yoksa GET /schema schema: null döndürür.
    201POST /pages sayfa oluşturdu veya POST /schema/process iş başlattı.
    400Zorunlu bir alan eksik veya türü yanlış, örneğin urlPath.
    401Authorization başlığı eksik veya anahtar geçersiz. GET /schema dışındaki uç noktalar, planda API erişimi yoksa veya çalışma alanı pasifse de 401 döndürür.
    403Yalnız GET /schema. Kod API_ACCESS_NOT_IN_PLAN veya WORKSPACE_INACTIVE olur (plan bitti veya ödeme ek süresi doldu).
    404Sayfa yok. GET /schema PAGE_NOT_FOUND gönderir. Sayfa servis için seçili değilse PAGE_NOT_SELECTED gönderir.
    409POST /pages: bu urlPath ile bir sayfa zaten var.
    429Hız sınırı aşıldı.
    500Sunucu hatası. Geri çekilmeyle yeniden deneyin.

    Uygulama esasları

    • Şemayı sunucunuzda alın ve HTML'e ekleyin. Böylece JavaScript çalıştırmayan AI tarayıcıları da şemayı görür.
    • Ziyaretçinin user agent bilgisini X-Client-User-Agent başlığıyla iletin. Brandop böylece AI bot ziyaretlerini kaydeder. X-Client-IP ve X-Client-Signature-Agent isteğe bağlıdır.
    • Brandop her şemayı en çok bir saat önbellekte tutar. Yeni üretim, düzenleme veya geri yükleme önbelleği temizler. Seçimi kaldırılan sayfa hemen durur.
    • Kendi tarafınızda da önbellek kullanıyorsanız süreyi kısa tutun. Tek bir sayfanın şeması yenilendiğinde webhook gönderilmez.
    • 429 ve 5xx yanıtlarını üstel geri çekilmeyle yeniden deneyin. Diğer 4xx isteklerini değişiklik yapmadan tekrarlamayın.
    • Şemayı güncel tutmak için Ayarlar, sonra Otomasyon bölümünden planlı yeniden üretimi açın. Her çalışma önce sayfaları yeniden tarar. Planlı yeniden üretim şu paketlerde yer alır: Pro, Agency ve Enterprise.
    • Aylık token bütçesi biterse yeni üretim işleri iptal edilir. Mevcut şema yayında kalır. Hazır şablon planı olan sayfalar token harcamaz ve güncellenmeye devam eder.