API v1

API Dokumentation

Integrieren Sie Beconova in Ihre Anwendung mit unserer leistungsstarken REST API. Einfache Integration mit Standard-HTTP-Requests.

API Key erhalten Interaktive API-Doku

REST API Schnellstart

Integrieren Sie Beconova mit einfachen fetch()-Aufrufen. Keine zusätzlichen Pakete nötig — verwenden Sie einfach die REST API mit Ihrem API Key.

Schnellstart

JavaScript / REST API

const API_KEY = 'lum_xxxxxxxxxxxxx';
const BASE_URL = 'https://api.beconova.de';

const headers = {
  'X-API-Key': API_KEY,
  'Content-Type': 'application/json',
};

// List your stores
const stores = await fetch(`${BASE_URL}/api/stores`, { headers })
  .then(res => res.json());

// Get visibility status
const status = await fetch(`${BASE_URL}/api/visibility-addon/status`, { headers })
  .then(res => res.json());
console.log(`AI Visibility Score: ${status.latestScore}`);

// List tracked keywords
const keywords = await fetch(`${BASE_URL}/api/visibility-addon/keywords`, { headers })
  .then(res => res.json());

Schnellstart

API Key erstellen

Registrieren Sie sich und erstellen Sie einen API Key in Ihrem Dashboard.

Request senden

Senden Sie Ihre ersten API-Requests mit Ihrem API Key.

Daten integrieren

Integrieren Sie die API-Antworten in Ihre Anwendung.

Authentifizierung

Alle API-Requests erfordern einen gültigen API Key im Authorization Header.

header

X-API-Key: lum_xxxxxxxxxxxxx

Sicherheitshinweis: Teilen Sie Ihren API Key niemals öffentlich. Verwenden Sie Umgebungsvariablen für die sichere Speicherung.

Endpoints

Methode	Endpoint	Beschreibung	Auth
GET	/api/stores	Alle Stores auflisten	Required
GET	/api/products	Liste aller Produkte abrufen	Required
POST	/api/products	Neues Produkt erstellen	Required
PUT	/api/products/:id	Produkt aktualisieren	Required
DELETE	/api/products/:id	Produkt löschen	Required
GET	/api/services	Liste aller Services abrufen	Required
POST	/api/validate	Schema-Validierung durchführen	Required
GET	/api/visibility-addon/status	AI Visibility Status & Score	Required
GET	/api/visibility-addon/keywords	Getrackte Keywords auflisten	Required
POST	/api/stores/:storeId/scan	Website-Scan auslösen	Required
GET	/api/stores/:storeId/scan-results	Scan-Ergebnisse abrufen	Required
GET	/api/visibility-addon/citations	AI-Zitierungen auflisten	Required
GET	/api/visibility-addon/competitors	Konkurrenten & Rankings abrufen	Required
GET	/api/gsc/analytics	Google Search Console Daten	Required
GET	/api/content/recommendations	Content-Empfehlungen abrufen	Required
GET	/api/sentiment/overview	Sentiment-Analyse Overview	Required

Rate Limits

Global1.000 req/15 min

Auth50 req/15 min

Visibility30 req/min

Publisher / Feeds90 req/min

Webhooks100 req/min

Rate-Limit-Informationen werden in den Antwort-Headern zurückgegeben: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Interaktive API-Dokumentation

Testen Sie alle Endpunkte direkt in der interaktiven Swagger UI. Alle 50+ Endpunkte mit Schemas, Beispielen und Try-It-Out Funktion.

Swagger UI öffnen

Code Beispiele

cURL

# List all products
curl -X GET "https://api.beconova.de/api/products?storeId=YOUR_STORE_ID" \
  -H "X-API-Key: lum_xxxxxxxxxxxxx"

# Start a website scan
curl -X POST "https://api.beconova.de/api/stores/YOUR_STORE_ID/scan" \
  -H "X-API-Key: lum_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"fullCrawl": true}'

# Get visibility score
curl -X GET "https://api.beconova.de/api/visibility-addon/status" \
  -H "X-API-Key: lum_xxxxxxxxxxxxx"

JavaScript / REST API

const API_KEY = 'lum_xxxxxxxxxxxxx';
const BASE_URL = 'https://api.beconova.de';
const headers = {
  'X-API-Key': API_KEY,
  'Content-Type': 'application/json',
};

// List products
const products = await fetch(
  `${BASE_URL}/api/products?storeId=YOUR_STORE_ID`,
  { headers }
).then(res => res.json());

// Create a product
await fetch(`${BASE_URL}/api/products`, {
  method: 'POST',
  headers,
  body: JSON.stringify({
    storeId: 'YOUR_STORE_ID',
    title: 'Premium Coffee Maker',
    brand: 'BrewMaster',
    category: 'Kitchen Appliances',
  }),
});

// Start a scan
await fetch(`${BASE_URL}/api/stores/YOUR_STORE_ID/scan`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ fullCrawl: true }),
});

// Error handling
const res = await fetch(`${BASE_URL}/api/stores/YOUR_STORE_ID`, { headers });
if (res.status === 429) {
  const retryAfter = res.headers.get('Retry-After');
  console.log(`Rate limited. Retry after ${retryAfter}s`);
}

Python

import requests

API_KEY = 'lum_xxxxxxxxxxxxx'
BASE_URL = 'https://api.beconova.de'
headers = {'X-API-Key': API_KEY}

# List stores
stores = requests.get(f'{BASE_URL}/api/stores', headers=headers).json()

# Get visibility status
status = requests.get(f'{BASE_URL}/api/visibility-addon/status', headers=headers).json()
print(f"Score: {status['latestScore']}")

# Add a keyword to track
requests.post(
    f'{BASE_URL}/api/visibility-addon/keywords',
    headers={**headers, 'Content-Type': 'application/json'},
    json={'keyword': 'best coffee maker'}
)

Brauchen Sie Hilfe?

Unser Entwickler-Support hilft Ihnen bei der Integration.

Support kontaktieren

Methode

Endpoint

Beschreibung

Auth

GET

/api/stores

Alle Stores auflisten

Required

GET

/api/products

Liste aller Produkte abrufen

Required

POST

/api/products

Neues Produkt erstellen

Required

PUT

/api/products/:id

Produkt aktualisieren

Required

DELETE

/api/products/:id

Produkt löschen

Required

GET

/api/services

Liste aller Services abrufen

Required

POST

/api/validate

Schema-Validierung durchführen

Required

GET

/api/visibility-addon/status

AI Visibility Status & Score

Required

GET

/api/visibility-addon/keywords

Getrackte Keywords auflisten

Required

POST

/api/stores/:storeId/scan

Website-Scan auslösen

Required

GET

/api/stores/:storeId/scan-results

Scan-Ergebnisse abrufen

Required

GET

/api/visibility-addon/citations

AI-Zitierungen auflisten

Required

GET

/api/visibility-addon/competitors

Konkurrenten & Rankings abrufen

Required

GET

/api/gsc/analytics

Google Search Console Daten

Required

GET

/api/content/recommendations

Content-Empfehlungen abrufen

Required

GET

/api/sentiment/overview

Sentiment-Analyse Overview

Required

# List all products curl -X GET "https://api.beconova.de/api/products?storeId=YOUR_STORE_ID" \ -H "X-API-Key: lum_xxxxxxxxxxxxx" # Start a website scan curl -X POST "https://api.beconova.de/api/stores/YOUR_STORE_ID/scan" \ -H "X-API-Key: lum_xxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{"fullCrawl": true}' # Get visibility score curl -X GET "https://api.beconova.de/api/visibility-addon/status" \ -H "X-API-Key: lum_xxxxxxxxxxxxx"

import requests API_KEY = 'lum_xxxxxxxxxxxxx' BASE_URL = 'https://api.beconova.de' headers = {'X-API-Key': API_KEY} # List stores stores = requests.get(f'{BASE_URL}/api/stores', headers=headers).json() # Get visibility status status = requests.get(f'{BASE_URL}/api/visibility-addon/status', headers=headers).json() print(f"Score: {status['latestScore']}") # Add a keyword to track requests.post( f'{BASE_URL}/api/visibility-addon/keywords', headers={**headers, 'Content-Type': 'application/json'}, json={'keyword': 'best coffee maker'} )