Bientôt

Cette fonctionnalité est en cours de développement. Inscrivez-vous à notre liste de diffusion pour être averti de son lancement.

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

Documentation de l’API

Intégrez la modélisation de propagation de Waveshed dans vos applications grâce à notre API REST. Disponible avec les offres Pro et Enterprise.

Authentification

Toutes les requêtes API nécessitent une clé API transmise dans l’en-tête Authorization. Générez des clés API depuis vos paramètres de compte.

# Incluez votre clé API dans chaque requête

curl -H "Authorization: Bearer YOUR_API_KEY" \

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

Gardez vos clés API secrètes. Ne les partagez pas dans du code côté client, des dépôts publics ou des emplacements non sécurisés. Renouvelez régulièrement vos clés depuis votre page de paramètres.

URL de base

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

Tous les endpoints sont relatifs à cette URL de base. HTTPS est requis.

Limites de débit

Offre	Requêtes / min	Sims simultanées
Pro	60	3
Enterprise	300	10

Les en-têtes de limite de débit (X-RateLimit-Remaining, X-RateLimit-Reset) sont inclus dans chaque réponse.

Référence des endpoints

POST /api/v1/simulate

Démarrer une nouvelle simulation de propagation

Corps de la requête

{
  "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
}

Réponse

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

GET /api/v1/status/:id

Obtenir le statut et les résultats d’une simulation

Réponse

{
  "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

Lister toutes les simulations de l’utilisateur authentifié

Réponse

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

DELETE /api/v1/simulations/:id

Supprimer une simulation et ses résultats

Réponse

(204 No Content)

GET /api/v1/credits

Obtenir le solde de crédits actuel et l’utilisation

Réponse

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

POST /api/v1/credits/purchase

Acheter des crédits de simulation supplémentaires

Corps de la requête

{
  "pack": "100"
}

Réponse

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

Codes d’erreur

Code	Signification
400	Bad Request - Paramètres invalides
401	Unauthorized - Clé API manquante ou invalide
403	Forbidden - Offre ou crédits insuffisants
404	Not Found - La simulation n’existe pas
429	Rate Limited - Trop de requêtes
500	Server Error - Une erreur est survenue de notre côté