التوثيق
توثيق BasedOnB
أتمتة استخراج العملاء المحتملين من خرائط جوجل عبر REST API، أو اتصل بمساعدي الذكاء الاصطناعي مباشرةً عبر خادم MCP.
جاهز للبناء؟
أنشئ أول مفتاح API لك من الإعدادات وابدأ الاستخراج خلال دقائق.
أتمتة استخراج العملاء المحتملين من خرائط جوجل عبر REST API، أو اتصل بمساعدي الذكاء الاصطناعي مباشرةً عبر خادم MCP.
أنشئ أول مفتاح API لك من الإعدادات وابدأ الاستخراج خلال دقائق.
curl https://www.basedonb.com/api/v1/account \
-H "Authorization: Bearer bdb_live_YOUR_KEY_HERE"جميع طلبات API (باستثناء ) تتطلب مفتاح API. أنشئ واحدًا من .
مرر مفتاحك بإحدى طريقتين:
ترويسة Authorization (موصى به)
Authorization: Bearer bdb_live_...
ترويسة X-API-Key
X-API-Key: bdb_live_...
https://www.basedonb.com/api/v1
100 طلب / دقيقة لكل مفتاح API. تجاوز ذلك يُرجع 429.
ابحث عن قيم الدولة / الولاية / المدينة التي تقبلها واجهة Scrapes. تتبع الولايات تنسيق رمز GeoNames المنقّط (US.CA, TR.34, DE.BE). الدول التي ليس لديها تقسيم فرعي تُرجع مصفوفة states فارغة — أرسل تلك المهام مع country فقط.
تسلّم الـ webhooks إشعارات الأحداث في الوقت الفعلي إلى نقطة النهاية الخاصة بك. كل طلب يتضمن ترويسة X-Webhook-Signature للتحقق.
مثال على حمولة scrape.done تُسلّم إلى نقطة النهاية الخاصة بك:
POST https://your-server.com/webhook
Content-Type: application/json
X-Webhook-Signature: sha256=abc123...
X-Event-Type: scrape.done
User-Agent: BasedOnB-Webhook/1.0
{
"event": "scrape.done",
"created_at": "2026-01-15T10:05:00Z",
"data": {
"scrape_id": "job-uuid",
"query": "restaurants",
"city": "Istanbul",
"country": "TR",
"state": "TR.34",
"state_name": "İstanbul",
"leads_found": 47,
"credits_charged": 47
}
}تحقق من ترويسة X-Webhook-Signature للتأكد من أن الطلبات واردة من BasedOnB. اعثر على سر الـ webhook الخاص بك في الإعدادات ← Webhooks.
import { createHmac } from "crypto";
function verifyWebhook(body: string, signature: string, secret: string): boolean {
const expected = "sha256=" + createHmac("sha256", secret).update(body).digest("hex");
return expected === signature;
}
// In your endpoint handler:
const body = await req.text();
const sig = req.headers.get("X-Webhook-Signature") ?? "";
if (!verifyWebhook(body, sig, process.env.WEBHOOK_SECRET!)) {
return new Response("Unauthorized", { status: 401 });
}| حالة HTTP | الرمز | الوصف |
|---|---|---|
| 401 | unauthorized | Missing or invalid API key |
| 403 | forbidden | API key valid but not allowed for this resource |
| 404 | not_found | Resource not found |
| 400 | bad_request | Invalid request parameters |
| 402 | insufficient_credits | Not enough credits to start a scrape |
| 429 | rate_limited | Too many open scrape jobs (max 3) or too many open target leads (max 5000). Wait for jobs to finish. |
| 500 | internal_error | Unexpected server error |
تنسيق استجابة الخطأ:
{
"error": {
"code": "insufficient_credits",
"message": "Not enough credits. You have 3 but need 50."
}
}basedonb'a Claude.ai, ChatGPT veya n8n gibi platformlardan tek tıkla yetki ver. API anahtarı yapıştırmaya gerek yok — OAuth 2.1 + PKCE ile güvenli, refresh tokenları arka planda çalışır, dilediğin zaman dashboard'dan iptal edebilirsin.
https://basedonb.com/api/mcphttps://basedonb.com/api/mcp.ChatGPT'nin custom connector özelliği aynı MCP URL'ini kabul eder.
https://basedonb.com/api/mcp.n8n'in dahili MCP Clientnode'unu kullan.
https://basedonb.com/api/mcp.اربط BasedOnB بـ Claude أو Cursor أو Windsurf أو أي عميل ذكاء اصطناعي متوافق مع MCP. نفس مفتاح API، نفس الأرصدة، نفس واجهة v1 — معروضة كـ 10 أدوات يمكن للذكاء الاصطناعي استدعاؤها مباشرة.
OAuth desteklemeyen yerel istemciler (Claude Code, Claude Desktop, Cursor) için config dosyasına MCP URL + uzun ömürlü API key gir. API anahtarını API & Webhooks sayfasından oluşturabilirsin.
اختر عميلك وانسخ المقتطف. استبدل المفتاح النائب بمفتاحك الخاص.
claude mcp add basedonb https://www.basedonb.com/api/mcp \
--transport http \
--header "Authorization: Bearer bdb_live_xxxxxxxxxxxxxxxxx"نفّذ هذا في أي طرفية. سيصبح MCP متاحًا في جميع جلسات Claude Code.
تستخدم جميع أدوات MCP نفس مفتاح bdb_live_… الخاص بـ REST API. مرّره عبر ترويسة Authorization: Bearer على نقل MCP.
MCP endpoint çift kimlik doğrulama destekler:
Authorization: Bearer eyJ...Authorization: Bearer bdb_live_...basedonb, OAuth 2.1 + PKCE + Dynamic Client Registration (RFC 7591) + Authorization Server Metadata (RFC 8414) standartlarını uygular.
GET /.well-known/oauth-protected-resource — RFC 9728 resource metadata.GET /.well-known/oauth-authorization-server — RFC 8414 AS metadata.POST /oauth/register — Dynamic Client Registration (açık, PKCE-only public client).GET /oauth/authorize — Login + consent; redirect_uri'ye ?code=…&state=… ile döner.POST /oauth/token — Code → access & refresh tokens; refresh rotation aktif.POST /oauth/revoke — RFC 7009 refresh token revocation.Access token JWT (HS256, 1 saat TTL). Refresh token opaque, her kullanımda rotate olur ve chain'e bağlıdır — leak şüphesi tespit edilirse tüm chain revoke edilir.