API de gestion Asteriomod

Accès programmatique à votre compte Asteriomod, au statut de vos modules et aux données de reporting. Réservé aux intégrations avancées et aux flux d’automatisation.

Accès à l’API : l’API de gestion Asteriomod est disponible pour tous les clients actifs. Générez une clé API depuis votre espace : Paramètres → API de gestion → Générer une clé.

URL de base

https://api.asteriomod.org/v1

Authentification

Toutes les requêtes doivent inclure un en-tête Authorization: Bearer <cle-api>. Chaque clé est propre à un compte et hérite du niveau d’accès du titulaire du compte. Les clés peuvent être révoquées à tout moment depuis l’espace client, sans impact sur les autres clés du même compte.

Format des réponses

Toutes les réponses sont au format JSON avec l’en-tête Content-Type: application/json; charset=utf-8. Les horodatages suivent la norme ISO 8601 en UTC. Les montants sont exprimés en euros au format décimal (par exemple "amount": 42.00).

Endpoints disponibles

Endpoint	Méthode	Description
`/modules`	`GET`	Liste tous les modules actifs et leur statut
`/modules/{id}/status`	`GET`	Statut détaillé d’un module précis
`/modules/{id}/logs`	`GET`	Récupère les 500 derniers appels API journalisés
`/credentials`	`GET`	Liste les jeux d’identifiants Asterio connectés (masqués)
`/credentials`	`POST`	Ajoute un nouveau jeu d’identifiants Asterio
`/credentials/{id}`	`DELETE`	Supprime un jeu d’identifiants Asterio
`/reports/{module}`	`GET`	Rapport d’utilisation d’un module sur une période
`/billing/invoices`	`GET`	Liste toutes les factures du compte
`/billing/invoices/{id}`	`GET`	Télécharge une facture au format PDF

Exemple — lister les modules actifs

curl -X GET https://api.asteriomod.org/v1/modules \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"

Exemple — ajouter un jeu d’identifiants Asterio

curl -X POST https://api.asteriomod.org/v1/credentials \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Propriété principale",
    "asterio_api_key": "as_xxxxxxxxxxxxxxxxxxxx",
    "property_id": "12345"
  }'

Exemple — récupérer un rapport d’utilisation

curl -X GET "https://api.asteriomod.org/v1/reports/as-rapport-tva?from=2026-01-01&to=2026-01-31" \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxx"

Limitation de débit

L’API est plafonnée à 120 requêtes par minute et par clé. Un code HTTP 429 est renvoyé lorsque la limite est dépassée. Utilisez la valeur de l’en-tête Retry-After dans votre logique de nouvel essai. Un mécanisme de back-off exponentiel est recommandé pour les intégrations en production.

Codes d’erreur

400 — requête mal formée (payload JSON invalide ou champ manquant)
401 — clé API absente ou invalide
403 — accès refusé pour la ressource demandée
404 — ressource introuvable
422 — validation métier échouée (par exemple identifiant Asterio déjà enregistré)
429 — limite de débit dépassée
500 — erreur interne (signalez-la à notre équipe d’assistance)

Webhooks sortants

Configurez une URL de webhook dans votre espace client pour recevoir en temps réel les notifications suivantes : échec de synchronisation d’un module, événement de facturation, activation ou résiliation d’un module. Les événements sont livrés au format JSON en POST HTTP, avec une signature HMAC-SHA256 dans l’en-tête X-Signature.

Questions

Toute question sur la documentation : support@asteriomod.org.