Übersicht

Die Mapfolio API bietet programmgesteuerten Zugriff auf Schweizer Unternehmensdaten über eine RESTful-Schnittstelle. Alle Endpunkte sind mit der OpenAPI 3.0-Spezifikation dokumentiert, was Konsistenz und einfache Integration gewährleistet.

Erste Schritte

Authentifizierung

Die Mapfolio API verwendet API-Schlüssel-Authentifizierung. Sie können Ihren API-Schlüssel in Ihren Kontoeinstellungen erhalten.

API-Schlüssel-Header:

X-API-Key: mapf_ihr_api_schluessel_hier

Bearer-Token (Alternative):

Authorization: Bearer mapf_ihr_api_schluessel_hier

Basis-URL

Alle API-Anfragen sollten an folgende Adresse gesendet werden:

https://mapfolio.app

Rate-Limiting

API-Anfragen sind rate-limitiert, um faire Nutzung sicherzustellen:

Authentifizierte Anfragen: 1000 Anfragen pro Stunde pro API-Schlüssel
Nicht authentifizierte Anfragen: 10 Anfragen pro Stunde pro IP-Adresse

Rate-Limit-Informationen sind in den Antwort-Headern enthalten:

X-RateLimit-Limit: Maximale zulässige Anfragen
X-RateLimit-Remaining: Verbleibende Anfragen im aktuellen Fenster
X-RateLimit-Reset: Unix-Zeitstempel, wenn das Limit zurückgesetzt wird

Verfügbare Endpunkte

Unternehmenssuche

Suchen Sie nach Unternehmen mit erweiterten Filteroptionen:

Textsuche in Unternehmensnamen
Filterung nach Kanton (Schweizer Kantone)
Filterung nach Unternehmensstatus
Paginierungsunterstützung

Unternehmensdetails

Rufen Sie detaillierte Informationen zu bestimmten Unternehmen ab:

Unternehmensprofildaten
Standortinformationen
Rechtsstatus
Registrierungsdetails

Statistiken

Zugriff auf aggregierte Statistiken zu Schweizer Unternehmen:

Gesamte Unternehmensanzahlen
Statistiken auf Kantonsebene
Buchstabenbasierte Verteilungen
Zwei-Buchstaben-Kombinationszählungen

Autovervollständigung

Erhalten Sie Autovervollständigungsvorschläge für:

Unternehmensnamen
Städte
Postleitzahlen

Zufällige Unternehmen

Rufen Sie zufällige Unternehmensstichproben für Tests und Erkundung ab.

Antwortformat

Alle erfolgreichen API-Antworten folgen einer konsistenten Struktur:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Fehlerantworten enthalten detaillierte Informationen:

{
  "error": "Fehlermeldung",
  "details": "Zusätzliche Fehlerdetails"
}

Fehlercodes

400 Bad Request: Ungültige Anfrageparameter
401 Unauthorized: Fehlender oder ungültiger API-Schlüssel
403 Forbidden: Unzureichende Berechtigungen
404 Not Found: Ressource nicht gefunden
429 Too Many Requests: Rate-Limit überschritten
500 Internal Server Error: Server-seitiger Fehler

OpenAPI-Spezifikation

Die vollständige OpenAPI 3.0-Spezifikation ist verfügbar unter:

Interaktive Dokumentation: /api-docs.html
OpenAPI JSON: /api/docs/openapi.json

Sie können die OpenAPI-Spezifikation mit jedem kompatiblen Tool verwenden:

Swagger UI
Postman
Insomnia
Code-Generatoren für Client-Bibliotheken

Code-Beispiele

cURL

curl -H "X-API-Key: mapf_ihr_api_schluessel_hier" \
  https://mapfolio.app/api/search?q=technologie

JavaScript (Fetch)

const response = await fetch('https://mapfolio.app/api/search?q=technologie', {
  headers: {
    'X-API-Key': 'mapf_ihr_api_schluessel_hier'
  }
})
const data = await response.json()

Python (Requests)

import requests

headers = {'X-API-Key': 'mapf_ihr_api_schluessel_hier'}
response = requests.get(
  'https://mapfolio.app/api/search',
  params={'q': 'technologie'},
  headers=headers
)
data = response.json()

Support

Für API-Support und Fragen:

Dokumentation: Besuchen Sie die interaktive API-Dokumentation
Email: support@mapfolio.app
Probleme: Melden Sie Probleme über Ihr Kontodashboard

Nutzungsbedingungen

Durch die Nutzung der Mapfolio API stimmen Sie unseren Nutzungsbedingungen und unserer Datenschutzerklärung zu. Bitte überprüfen Sie Rate-Limits und Nutzungsrichtlinien, um die Einhaltung sicherzustellen.