API v1

API Documentatie

Integreer Beconova in uw applicatie met onze krachtige REST API. Eenvoudige integratie met standaard HTTP-verzoeken.

API Key verkrijgen →Interactieve API-documentatie

REST API Snelstart

Integreer Beconova met eenvoudige fetch()-aanroepen. Geen extra pakketten nodig — gebruik gewoon de REST API met uw API Key.

Snelstart

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());

Snelstart

API Key aanmaken

Registreer u en maak een API Key aan in uw dashboard.

Verzoek verzenden

Verzend uw eerste API-verzoeken met uw API Key.

Data integreren

Integreer de API-antwoorden in uw applicatie.

Authenticatie

Alle API-verzoeken vereisen een geldige API Key in de Authorization header.

header

X-API-Key: lum_xxxxxxxxxxxxx

Beveiligingsopmerking: Deel uw API Key nooit openbaar. Gebruik omgevingsvariabelen voor veilige opslag.

Endpoints

Methode	Endpoint	Beschrijving	Auth
GET	/api/stores	Alle stores weergeven	Required
GET	/api/products	Lijst van alle producten ophalen	Required
POST	/api/products	Nieuw product aanmaken	Required
PUT	/api/products/:id	Product bijwerken	Required
DELETE	/api/products/:id	Product verwijderen	Required
GET	/api/services	Lijst van alle services ophalen	Required
POST	/api/validate	Schema-validatie uitvoeren	Required
GET	/api/visibility-addon/status	AI-zichtbaarheidsstatus en score	Required
GET	/api/visibility-addon/keywords	Gevolgde zoekwoorden weergeven	Required
POST	/api/stores/:storeId/scan	Websitescan starten	Required
GET	/api/stores/:storeId/scan-results	Scanresultaten ophalen	Required
GET	/api/visibility-addon/citations	AI-citaten weergeven	Required
GET	/api/visibility-addon/competitors	Concurrenten en rankings ophalen	Required
GET	/api/gsc/analytics	Google Search Console gegevens	Required
GET	/api/content/recommendations	Contentaanbevelingen ophalen	Required
GET	/api/sentiment/overview	Overzicht sentimentanalyse	Required

Rate Limits

Global1.000 req/15 min

Auth50 req/15 min

Visibility30 req/min

Publisher / Feeds90 req/min

Webhooks100 req/min

Rate limit informatie wordt geretourneerd in de response headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.

Interactieve API-documentatie

Test alle endpoints direct in de interactieve Swagger UI. Alle 50+ endpoints met schema's, voorbeelden en uitprobeer-functionaliteit.

Swagger UI openen

Codevoorbeelden

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'}
)

Hulp nodig?

Onze ontwikkelaarssupport helpt u bij de integratie.

Support contacteren

Methode

Endpoint

Beschrijving

Auth

GET

/api/stores

Alle stores weergeven

Required

GET

/api/products

Lijst van alle producten ophalen

Required

POST

/api/products

Nieuw product aanmaken

Required

PUT

/api/products/:id

Product bijwerken

Required

DELETE

/api/products/:id

Product verwijderen

Required

GET

/api/services

Lijst van alle services ophalen

Required

POST

/api/validate

Schema-validatie uitvoeren

Required

GET

/api/visibility-addon/status

AI-zichtbaarheidsstatus en score

Required

GET

/api/visibility-addon/keywords

Gevolgde zoekwoorden weergeven

Required

POST

/api/stores/:storeId/scan

Websitescan starten

Required

GET

/api/stores/:storeId/scan-results

Scanresultaten ophalen

Required

GET

/api/visibility-addon/citations

AI-citaten weergeven

Required

GET

/api/visibility-addon/competitors

Concurrenten en rankings ophalen

Required

GET

/api/gsc/analytics

Google Search Console gegevens

Required

GET

/api/content/recommendations

Contentaanbevelingen ophalen

Required

GET

/api/sentiment/overview

Overzicht sentimentanalyse

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'} )