BasedOnB API-Referenz
Automatisieren Sie das Scraping von Google-Maps-Leads, verwalten Sie Webhooks und integrieren Sie Ihr CRM oder Ihre Workflow-Automatisierungstools.
Schnellstart
curl https://www.basedonb.com/api/v1/account \
-H "Authorization: Bearer bdb_live_YOUR_KEY_HERE"Authentifizierung
Alle API-Anfragen (außer GET /api/v1/health) erfordern einen API-Schlüssel. Erstellen Sie einen über Einstellungen → API-Schlüssel.
Übergeben Sie Ihren Schlüssel auf eine von zwei Arten:
Authorization-Header (empfohlen)
Authorization: Bearer bdb_live_...
X-API-Key-Header
X-API-Key: bdb_live_...
Basis-URL
https://www.basedonb.com/api/v1
Ratenbegrenzungen
100 Anfragen / Minute pro API-Schlüssel. Eine Überschreitung gibt 429 Too Many Requests zurück.
Endpunkte
Health
Konto
Scrapes
Geodaten
Suchen Sie die von der Scrapes-API akzeptierten Werte für Land / Bundesland / Stadt. Bundesländer folgen dem GeoNames-Punktcode-Format (US.TX, TR.34, DE.02). Länder ohne Unterteilung geben ein leeres states-Array zurück — senden Sie diese Jobs nur mit country.
Credits & Abrechnung
Webhooks
Webhooks liefern Echtzeit-Ereignisbenachrichtigungen an Ihren Endpunkt. Jede Anfrage enthält einen X-Webhook-Signature: sha256=<hex>-Header zur Verifizierung.
Webhook-Payload
Beispiel-scrape.done-Payload, die an Ihren Endpunkt geliefert wird:
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": "Turkey",
"leads_found": 47,
"credits_charged": 47
}
}Webhook-Signaturen verifizieren
Verifizieren Sie den X-Webhook-Signature-Header, um sicherzustellen, dass Anfragen von BasedOnB stammen. Ihr Webhook-Secret finden Sie unter Einstellungen → 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 });
}API-Schlüssel-Verwaltung
Fehlercodes
| HTTP-Status | Code | Beschreibung |
|---|---|---|
| 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 requests. Retry after 1 minute |
| 500 | internal_error | Unexpected server error |
Fehler-Antwortformat:
{
"error": {
"code": "insufficient_credits",
"message": "Not enough credits. You have 3 but need 50."
}
}Bereit zu entwickeln?
Generieren Sie Ihren ersten API-Schlüssel in den Einstellungen und beginnen Sie in wenigen Minuten mit dem Scraping.