İ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.comkullanılır.
1. API anahtarı oluşturun
- Çalışma alanınızı açın ve Ayarlar sayfasına gidin.
- Entegrasyonlar sekmesini, sonra API Anahtarları bölümünü açın.
- Yeni Anahtar Oluştur düğmesine tıklayın.
- Anahtarı kopyalayın. Anahtar yalnız bir kez görünür.
Anahtarı sunucunuzda bir ortam değişkeninde saklayın:
export BRANDOP_API_KEY="YOUR_API_KEY"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.
curl "https://brandop.ai/api/v2/pages?limit=5" \
-H "Authorization: Bearer $BRANDOP_API_KEY"{
"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.
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"}'{
"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.
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"{
"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.
// 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
- API referansı: bütün uç noktalar ve parametreler.
- Teknik dokümantasyon: plana göre hız sınırları ve hata kodları.
- Entegrasyon rehberleri: sunucu tarafı kod örnekleri ve WordPress.
- Webhook'lar: tarama bitince bildirim alın.
- MCP kurulumu: çalışma alanınızı bir AI asistanından kullanın.