API Dokümantasyonu

    Brandop'a programatik erişim

    Başlangıç

    Brandop API, projelerinizi, sayfalarınızı ve şemalarınızı Arama Motorları ve AI Yanıt Motorları için programatik olarak yönetmenizi sağlar. Tüm API uç noktaları API anahtarı ile kimlik doğrulama gerektirir.

    Kimlik Doğrulama

    Tüm API istekleri, Bearer şeması ile Authorization başlığında API anahtarınızı içermelidir:

    curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://brandop.ai/api/v2/projects

    Güvenlik Notu: API anahtarlarınızı gizli tutun. Asla sürüm kontrolüne eklemeyin veya istemci tarafı kodda ifşa etmeyin.

    Temel URL

    https://brandop.ai/api/v2

    API Uç Noktaları

    Tam REST API referansı - Tüm uç noktalar API anahtarıyla kimlik doğrulama kullanır

    Sayfalar

    GET/pages

    Çalışma alanındaki tüm sayfaları listeler (API anahtarından otomatik belirlenir)

    Sorgu parametreleri: page, limit, activeOnly

    POST/pages

    Elle yeni bir sayfa oluşturur.

    {
  "urlPath": "/new-page"
}
    PATCH/pages

    Şema üretimi için sayfa seçimini açıp kapatır

    {
  "urlPath": "/about",
  "isSelectedForSchema": true
}

    Şemalar

    GET/schema?urlPath=/about

    URL yoluna göre bir sayfanın en güncel şemasını getirir. İstekler CDN analitiğinde izlenir.

    POST/schema/process

    Hepsi bir arada uç nokta: Gerekirse sayfa oluşturur, HTML yoksa tarar, şema üretir/yeniler ve sayfayı yayın için aktif eder. Özel şemalı sayfalar varsayılan olarak korunur.

    {
  "urlPath": "/about",
  "forceRegenerate": false // Set true to override custom schemas
}

    Analitik

    GET/analytics

    Toplam istek, en çok kullanılan yollar ve haftalık veriler dahil CDN analitik verilerini getirir

    İşler

    POST/jobs/stop

    Çalışma alanındaki tüm bekleyen ve işlenen işleri (tarama ve şema üretimi) durdurur. Durdurulan işlerin sayısını ve ayrıntılarını döndürür. Uzun süren işlemleri iptal etmek veya takılı kalan işleri sonlandırmak için kullanışlıdır.

    Yanıt: stoppedCount, jobs[] (id, type, previousStatus)

    Yanıt Formatı

    Tüm API yanıtları şu formatı izler:

    Başarılı Yanıt:

    {
  "success": true,
  "data": { ... }
}

    Hata Yanıtı:

    {
  "error": "Error message here"
}

    Hız Sınırı

    API istekleri planınıza göre hız sınırına tabidir. Güncel sınırlar için destekle iletişime geçin.

    Hız sınırı bilgileri yanıt başlıklarında bulunur:

    X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

    Örnek İstekler

    cURL ile tam örnekler

    # List all pages for the workspace (determined by API key)
curl -X GET https://brandop.ai/api/v2/pages \
  -H "Authorization: Bearer YOUR_API_KEY"

# List only active pages (with schema enabled)
curl -X GET "https://brandop.ai/api/v2/pages?activeOnly=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Create a new page manually
curl -X POST https://brandop.ai/api/v2/pages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urlPath": "/new-page"
  }'

# Toggle page selection for schema (cache is auto-invalidated)
curl -X PATCH https://brandop.ai/api/v2/pages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urlPath": "/about",
    "isSelectedForSchema": true
  }'

# Get schema for a page by URL path
curl -X GET "https://brandop.ai/api/v2/schema?urlPath=/about" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Process schema (all-in-one: create page + crawl + generate + activate)
# Pages with custom schemas are protected - use forceRegenerate to override
curl -X POST https://brandop.ai/api/v2/schema/process \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "urlPath": "/about",
    "forceRegenerate": false
  }'

# Get CDN analytics
curl -X GET https://brandop.ai/api/v2/analytics \
  -H "Authorization: Bearer YOUR_API_KEY"

# Stop all pending and processing jobs
curl -X POST https://brandop.ai/api/v2/jobs/stop \
  -H "Authorization: Bearer YOUR_API_KEY"

    En İyi Uygulamalar

    • API anahtarlarını ortam değişkenlerinde güvenli şekilde saklayın
    • Hız limiti hataları (429) için üstel geri çekilme uygulayın
    • Sayfaları tanımlamak için dahili ID yerine urlPath parametresini kullanın
    • Güvenlik için API anahtarlarını düzenli olarak döndürün
    • Proje bağlamı API anahtarınızdan otomatik olarak belirlenir

    HTTP Durum Kodları

    200Başarılı
    400Hatalı İstek - Geçersiz parametreler veya URL doğrulaması başarısız (sayfa yok, bot koruması algılandı vb.)
    401Yetkisiz - Geçersiz veya eksik API anahtarı
    403Yasak - API erişimi planda mevcut değil
    404Bulunamadı - Kaynak mevcut değil
    429Çok Fazla İstek - Hız limiti veya token limiti aşıldı
    500Sunucu İç Hatası
    API Dokümantasyonu | Brandop