İlk API isteğinizi gönderin.

    API anahtarı oluşturun, bağlantıyı test edin ve bir sayfanın şemasını alın.

    Başlamadan önce

    • API erişimi olan bir plan: Pro, Agency ve Enterprise.
    • Çalışma alanında sahip veya yönetici rolü.
    • Siteniz için bir çalışma alanı. Örneklerde example.com kullanılır.

    1. API anahtarı oluşturun

    1. Çalışma alanınızı açın ve Ayarlar sayfasına gidin.
    2. Entegrasyonlar sekmesini, sonra API Anahtarları bölümünü açın.
    3. Yeni Anahtar Oluştur düğmesine tıklayın.
    4. Anahtarı kopyalayın. Anahtar yalnız bir kez görünür.

    Anahtarı sunucunuzda bir ortam değişkeninde saklayın:

    Terminal
    export BRANDOP_API_KEY="YOUR_API_KEY"
    Anahtarı asla tarayıcıya göndermeyin. API'yi yalnız sunucunuzdan çağırın.

    2. Bağlantıyı test edin

    Çalışma alanının sayfalarını listeleyin. Çalışma alanını anahtar belirler. Bu yüzden istekte çalışma alanı kimliği yoktur.

    İstek
    curl "https://brandop.ai/api/v2/pages?limit=5" \
      -H "Authorization: Bearer $BRANDOP_API_KEY"
    Yanıt
    {
      "success": true,
      "data": {
        "pages": [
          {
            "id": "3f2b8c1e-6d4a-5b7e-9c10-2a4e6f8b0d12",
            "urlPath": "/pricing",
            "fullUrl": "https://example.com/pricing",
            "title": "Pricing",
            "isSelectedForSchema": true,
            "schemaCategory": null,
            "lastSchemaGeneratedAt": "2026-10-12T08:30:00.000Z",
            "lastCrawledAt": "2026-10-12T08:29:41.000Z",
            "currentJobStatus": "completed"
          }
        ],
        "pagination": { "page": 1, "limit": 5, "total": 42, "totalPages": 9 }
      }
    }

    limit varsayılan olarak 50, en çok 100'dür. activeOnly=true yalnız servis için seçili sayfaları döndürür.

    3. Şema üretin

    POST /schema/process bir URL yolu için akışın tamamını çalıştırır. Gerekirse sayfayı oluşturur ve servis için seçer. Henüz HTML yoksa sayfayı tarar. Sonra şema üretimini başlatır.

    İstek
    curl -X POST "https://brandop.ai/api/v2/schema/process" \
      -H "Authorization: Bearer $BRANDOP_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{"urlPath": "/products/product-name"}'
    Yanıt · 201
    {
      "success": true,
      "data": {
        "page": {
          "id": "7a1c9e3b-2f4d-5a6b-8c0d-1e2f3a4b5c6d",
          "urlPath": "/products/product-name",
          "fullUrl": "https://example.com/products/product-name",
          "isSelectedForSchema": true,
          "isNew": true
        },
        "job": {
          "id": "c4d5e6f7-8a9b-5c0d-9e1f-2a3b4c5d6e7f",
          "type": "crawl_page",
          "status": "pending"
        }
      },
      "message": "Page will be crawled and schema generated. Check job status for progress."
    }

    Üretim arka planda çalışır. Sayfa için çalışan bir iş varsa yanıt o işi döndürür.

    Sayfada elle düzenleme varsa yanıtta hasCustomSchema: true olur ve iş başlamaz. Elle düzenlenen şemanın yerine yenisini üretmek için çalışma alanı ayarlarında Manuel düzenlenmiş şemaları koru ayarını kapatın. Sonra sayfayı panelden yeniden üretin.

    4. Şemayı alın

    GET /schema uç noktasını URL yoluyla çağırın. Brandop'un AI bot ziyaretlerini kaydetmesi için ziyaretçinin user agent bilgisini iletin. Yolları sonda eğik çizgi olmadan gönderin. Sorgu dizesi dikkate alınmaz.

    İstek
    curl "https://brandop.ai/api/v2/schema?urlPath=/products/product-name" \
      -H "Authorization: Bearer $BRANDOP_API_KEY" \
      -H "X-Client-User-Agent: $VISITOR_USER_AGENT"
    Yanıt
    {
      "success": true,
      "data": {
        "page": {
          "id": "7a1c9e3b-2f4d-5a6b-8c0d-1e2f3a4b5c6d",
          "urlPath": "/products/product-name",
          "fullUrl": "https://example.com/products/product-name"
        },
        "schema": {
          "id": "9b8a7c6d-5e4f-5a3b-8c2d-1e0f9a8b7c6d",
          "jsonLd": {
            "@context": "https://schema.org",
            "@type": "Product",
            "name": "Product Name",
            "url": "https://example.com/products/product-name",
            "offers": { "@type": "Offer", "price": "49.00", "priceCurrency": "USD" }
          },
          "schemaHtml": "<script id=\"Brandop-jsonld\" type=\"application/ld+json\">{...}</script>",
          "isCustomized": false,
          "createdAt": "2026-10-12T08:30:00.000Z",
          "customizedAt": null
        }
      },
      "visitor": { "type": "human" }
    }

    Yeni bir sayfa ilk üretim bitene kadar data.schema: null döndürür. Yeniden üretilen sayfa, yenisi hazır olana kadar önceki şemayı verir.

    data.schema.schemaHtml değerini sayfanın <head> bölümüne ekleyin. Bu değer hazır bir <script type="application/ld+json"> etiketidir.

    JavaScript
    // On your server, while rendering the page
    const res = await fetch(
      `https://brandop.ai/api/v2/schema?urlPath=${encodeURIComponent(path)}`,
      {
        headers: {
          Authorization: `Bearer ${process.env.BRANDOP_API_KEY}`,
          "X-Client-User-Agent": request.headers.get("user-agent") ?? "",
        },
      },
    );
    const body = res.ok ? await res.json() : null;
    const schemaHtml = body?.data?.schema?.schemaHtml ?? "";
    // Put schemaHtml inside <head>.

    Sonraki adımlar