Bald verfügbar

An diesem Feature arbeiten wir noch. Tragen Sie sich in den Newsletter ein, dann informieren wir Sie zum Start.

REST API · api.waveshed.io · Pro & Enterprise

API-Dokumentation

Binden Sie die Ausbreitungsberechnung von Waveshed per REST API in Ihre Anwendungen ein. Verfügbar in den Tarifen Pro und Enterprise.

Authentifizierung

Jede API-Anfrage benötigt einen API-Schlüssel, den Sie im Authorization-Header mitschicken. Neue API-Schlüssel erstellen Sie in Ihren Kontoeinstellungen.

# Schicken Sie Ihren API-Schlüssel bei jeder Anfrage mit

curl -H "Authorization: Bearer YOUR_API_KEY" \

https://api.waveshed.io/api/v1/credits

Behandeln Sie Ihre API-Schlüssel vertraulich. Geben Sie sie nicht in clientseitigem Code, in öffentlichen Repositories oder an ungesicherten Stellen weiter. Tauschen Sie die Schlüssel regelmäßig in den Einstellungen aus.

Basis-URL

https://api.waveshed.io/api/v1

Alle Endpunkte beziehen sich auf diese Basis-URL. HTTPS ist Pflicht.

Rate Limits

Tarif	Anfragen / Min.	Parallele Sims
Pro	60	3
Enterprise	300	10

Die Header zum Rate Limit (X-RateLimit-Remaining, X-RateLimit-Reset) sind in jeder Antwort enthalten.

Übersicht der Endpunkte

POST /api/v1/simulate

Eine neue Ausbreitungssimulation starten

Anfrage-Body

{
  "name": "Coverage analysis",
  "tx_lat": 47.0563,
  "tx_lon": 8.4846,
  "tx_height": 30,
  "frequency": 433,
  "erp": 10,
  "rx_height": 1.5,
  "model": "los",
  "resolution": 30,
  "max_range": 20
}

Antwort

{
  "id": "sim_abc123",
  "status": "pending",
  "created_at": "2026-05-08T12:00:00Z"
}

GET /api/v1/status/:id

Status und Ergebnisse einer Simulation abrufen

Antwort

{
  "id": "sim_abc123",
  "status": "completed",
  "params": { "tx_lat": 47.0563, "tx_lon": 8.4846, ... },
  "credits_charged": 1,
  "result_url": "/results/sim_abc123.tif",
  "created_at": "2026-05-08T12:00:00Z",
  "completed_at": "2026-05-08T12:00:12Z"
}

GET /api/v1/simulations

Alle Simulationen des angemeldeten Nutzers auflisten

Antwort

{
  "simulations": [...],
  "total": 42
}

DELETE /api/v1/simulations/:id

Eine Simulation samt Ergebnissen löschen

Antwort

(204 No Content)

GET /api/v1/credits

Aktuelles Credit-Guthaben und den Verbrauch abrufen

Antwort

{
  "balance": 147,
  "plan": "pro",
  "used_this_month": 53,
  "limit": 200
}

POST /api/v1/credits/purchase

Weitere Credits für Simulationen kaufen

Anfrage-Body

{
  "pack": "100"
}

Antwort

{
  "checkout_url": "https://checkout.stripe.com/..."
}

Fehlercodes

Code	Bedeutung
400	Bad Request - Ungültige Parameter
401	Unauthorized - API-Schlüssel fehlt oder ist ungültig
403	Forbidden - Tarif reicht nicht aus oder zu wenige Credits
404	Not Found - Simulation existiert nicht
429	Rate Limited - Zu viele Anfragen
500	Server Error - Bei uns ist etwas schiefgelaufen