API-Dokumentation v2.0
Programmatischer Zugriff auf das Bundesweite Branchenregisterportal
Base URL
https://api.Branchenregisterportal.de/v2
Protokoll
REST / JSON
Authentifizierung
OAuth 2.0 / API-Key
Rate Limit
1000-10000 Req/h
Authentifizierung
OAuth 2.0 (empfohlen)
POST https://api.Branchenregisterportal.de/v2/oauth/token
Content-Type: application/json
{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"grant_type": "client_credentials"
}
API-Key (einfach)
GET https://api.Branchenregisterportal.de/v2/companies
Authorization: Bearer YOUR_API_KEY
API-Endpunkte
| Method | Endpoint | Beschreibung | Auth |
|---|---|---|---|
| GET | /companies | Liste aller Unternehmen (paginiert) | Required |
| GET | /companies/:id | Einzelnes Unternehmen abrufen | Required |
| POST | /companies | Neues Unternehmen erstellen | Required |
| PUT | /companies/:id | Unternehmen aktualisieren | Required |
| DELETE | /companies/:id | Unternehmen löschen | Required |
| GET | /companies/search | Erweiterte Suche mit Filtern | Required |
| GET | /categories | Alle Kategorien abrufen | Optional |
| GET | /cities | Alle Städte abrufen | Optional |
| GET | /companies/:id/reviews | Bewertungen eines Unternehmens | Optional |
| POST | /companies/:id/reviews | Neue Bewertung erstellen | Required |
Beispiel-Requests
GET /companies - Liste aller Unternehmen
GET https://api.Branchenregisterportal.de/v2/companies?page=1&limit=50
Authorization: Bearer YOUR_API_KEY
Response (200 OK):
{
"data": [
{
"id": "12345",
"name": "Mustermann GmbH",
"category": "restaurants",
"city": "Berlin",
"rating": 4.8,
"verified": true
}
],
"meta": {
"total": 1247832,
"page": 1,
"limit": 50,
"pages": 24957
}
}
GET /companies/search - Erweiterte Suche
GET https://api.Branchenregisterportal.de/v2/companies/search
?q=Restaurant
&city=berlin
&category=restaurants
&verified=true
&minRating=4.0
&sort=rating
&order=desc
Rate Limits & Preise
| Plan | Requests/Stunde | Requests/Tag | Webhooks | Support | Preis/Monat |
|---|---|---|---|---|---|
| Basic | 1.000 | 10.000 | - | Kostenlos | |
| Professional | 10.000 | 100.000 | ✓ | E-Mail + Chat | 199,00 € |
| Business | 50.000 | 1.000.000 | ✓ | Priotisiert | 699,00 € |
| Enterprise | Unbegrenzt | Unbegrenzt | ✓ | 24/7 Hotline | Auf Anfrage |
Webhooks
Professional+ Kunden können Webhooks einrichten, um Echtzeit-Benachrichtigungen bei Datenänderungen zu erhalten.
| Event | Beschreibung | Payload |
|---|---|---|
| company.created | Neues Unternehmen wurde erstellt | Company-Objekt |
| company.updated | Unternehmen wurde aktualisiert | Company-Objekt + Changes |
| company.deleted | Unternehmen wurde gelöscht | Company ID |
| review.created | Neue Bewertung wurde erstellt | Review-Objekt |
HTTP Status-Codes & Fehlerbehandlung
| Code | Bedeutung | Beschreibung |
|---|---|---|
| 200 | OK | Request erfolgreich |
| 201 | Created | Ressource erfolgreich erstellt |
| 400 | Bad Request | Ungültige Parameter oder Datenformat |
| 401 | Unauthorized | Fehlende oder ungültige Authentifizierung |
| 403 | Forbidden | Zugriff nicht erlaubt (Berechtigungen) |
| 404 | Not Found | Ressource nicht gefunden |
| 429 | Too Many Requests | Rate Limit überschritten |
| 500 | Internal Server Error | Serverfehler - bitte Support kontaktieren |
API-Zugang beantragen
Interessiert an unserem API-Zugang? Kontaktieren Sie unser Entwickler-Team: