Alloovium

Démarrer

Référence API

Chaque endpoint v2 dispose d'une référence interactive et en direct rendue directement depuis le schéma OpenAPI. Vous pouvez lire la spec, essayer des requêtes contre l'API de production et copier des extraits curl fonctionnels — sans configuration supplémentaire.

Référence interactive

La référence interactive est générée par Scalar depuis le document OpenAPI canonique. Elle est servie directement par l'application FastAPI, donc toujours synchronisée avec la version en cours de l'API :

bash
https://api.alloovium.com/api/v2/docs

Ouvrez-la dans un navigateur et vous obtenez des constructeurs de requêtes par endpoint, des explorateurs de schéma et des extraits curl / Python / JavaScript / Go en un clic pour chaque capability.

Document OpenAPI

Le JSON OpenAPI 3.1 brut est disponible sur :

bash
https://api.alloovium.com/api/v2/openapi.json

Utilisez-le pour générer des SDKs (gen, ts, go), alimenter des collections Postman / Insomnia, ou piloter des tests de contrat. La spec couvre toute la surface — chaque route REST sous prefix, l'enveloppe d'erreur, les exigences de scope et les limites de débit par endpoint.

Régénérer rapidement un client TypeScript

bash
npx openapi-typescript https://api.alloovium.com/api/v2/openapi.json \
  --output ./alloovium.d.ts

Ou un client Python

bash
openapi-python-client generate \
  --url https://api.alloovium.com/api/v2/openapi.json

Ce qui est où

La référence interactive est la source de vérité pour les formes requête/réponse. Les pages sous Capabilities dans ce site de documentation sont le guide opinioné — elles expliquent pourquoi un endpoint existe et quand vous devriez l'appeler, avec des exemples travaillés et des notes de conception que vous ne trouverez pas dans le schéma brut.

Utilisez les deux ensemble

Lisez le guide de capability pour comprendre une fonctionnalité, puis ouvrez la référence Scalar pour approfondir les types de champs exacts, les valeurs d'énumération et les codes d'erreur.

URLs de base de l'API

bash
# Production
https://api.alloovium.com/api/v2

Chaque chemin REST dans cette documentation est relatif à cette URL de base de production. Un environnement de staging distinct est disponible pour la validation pré-production ; utilisez l'URL de base de staging listée dans le bloc OpenAPI servers en direct ou fournie avec vos identifiants de staging. Les clés de test (préfixe test) sont destinées aux environnements non-production ; les clés live (live) sont pour le trafic de production.

Voir aussi