Skip to content

API Astrub.net

Astrub.net edited this page Sep 9, 2026 · 1 revision

API Astrub.net

Le dépôt contient une implémentation PHP de référence pour recevoir les contributions anonymes.

Requête

Le Companion envoie une requête POST HTTPS avec un objet JSON structuré. Les champs acceptés comprennent notamment le serveur, l’objet, le prix, la quantité, la source, la date et les UUID anonymes prévus par le schéma.

Validation recommandée

L’API doit :

  • refuser les méthodes autres que POST ;
  • vérifier strictement les champs autorisés ;
  • accepter uniquement la quantité 1 ;
  • refuser les prix nuls ou hors limites ;
  • vérifier l’existence du serveur et de l’objet ;
  • limiter l’âge des observations ;
  • rendre event_id idempotent ;
  • appliquer une limitation de débit ;
  • ne jamais faire confiance à l’UUID d’installation comme authentification.

Réponses courantes

  • 200 : contribution acceptée ou déjà connue ;
  • 401 : ancienne configuration nécessitant encore un token ;
  • 422 : contenu invalide ;
  • 429 : limite de débit atteinte ;
  • 5xx : indisponibilité temporaire.

L’API de production doit rester derrière HTTPS. Le code d’exemple se trouve dans api/public/api/companion/.

Clone this wiki locally