Alloovium

Démarrer

Démarrage rapide

De zéro à votre premier appel API réussi en moins de cinq minutes. Ce guide utilise une clé API ; pour les flux OAuth, voir Authentification.

1. Créer une clé API

Connectez-vous et ouvrez la Console développeur, puis cliquez sur Créer une clé API pour ouvrir la gestion des clés. Donnez un nom à la clé et choisissez un environnement :

  • prefix — clés préfixées code. Utilisez-les pour le trafic de production.
  • prefix — clés préfixées code. Utilisez-les en CI et développement local. Elles peuvent parler aux deux environnements.

Une seule chance de copier

La clé brute n'est affichée qu'une seule fois lors de la création. Stockez-la dans un gestionnaire de secrets. Si vous la perdez, révoquez-la et créez-en une nouvelle.

Les clés ressemblent à ceci : example. Elles contiennent l'utilisateur, le tenant, l'environnement, le niveau et l'ensemble de scopes.

100 $ de crédits gratuits inclus

Les nouveaux comptes développeurs démarrent avec 100 000 crédits API gratuits — valant 100 $ à 0,001 $ par crédit — afin que vous puissiez valider votre intégration avant de vous engager sur le trafic payant. Aucune carte de crédit requise. Surveillez l'utilisation depuis la Console développeur.

2. Authentifier chaque requête

Envoyez la clé comme header HTTP header. Ne mettez pas la clé dans une query string, un cookie ou le corps de la requête.

http
GET /api/v2/me HTTP/1.1
Host: api.alloovium.com
Authorization: Bearer ak_live_AB7K2LJ...
Accept: application/json

3. Appeler votre premier endpoint

L'endpoint path est le health check recommandé. Il coûte 1 token de limite de débit, ne requiert aucun scope et retourne le principal complet derrière votre identifiant.

bash
curl -sS https://api.alloovium.com/api/v2/me \
  -H "Authorization: Bearer $ALLOOVIUM_API_KEY"

Réponse

json
{
  "user_id": "1f02d9ef-2b33-4d1d-9c4a-82f06a91e3d1",
  "tenant_id": "c7a1e9c2-9c1e-4e4e-bf97-a4b5e76cf9c8",
  "auth_method": "api_key",
  "email": "alex@example.com",
  "api_key_id": "5e2f09bb-9c1e-4e4e-bf97-a4b5e76cf9c8",
  "api_key_name": "Production Backend",
  "api_key_prefix": "ak_live_AB7K",
  "environment": "live",
  "rate_limit_tier": "standard",
  "scopes": [
    "vault:read",
    "vault:write",
    "chat:read",
    "chat:write"
  ]
}

4. Lister vos projets

Appelez maintenant un endpoint scopé. Celui-ci nécessite scope, coûte 1 token et est paginé par curseur.

bash
curl -sS "https://api.alloovium.com/api/v2/vault/projects?limit=10" \
  -H "Authorization: Bearer $ALLOOVIUM_API_KEY"
json
{
  "data": [
    {
      "id": "8f2e3c1a-...",
      "name": "Downtown Tower",
      "description": "Mixed-use high-rise.",
      "project_type": "commercial",
      "status": "active",
      "created_at": "2026-04-02T10:12:34+00:00"
    }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNC0wMlQxMDoxMjozNCswMDowMCIsImlkIjoiOGYyZTNjMWEifQ",
  "has_more": true
}

Passez cursor en retour comme param pour récupérer la page suivante. Voir Pagination pour l'enveloppe complète.

5. Gérer les erreurs

Chaque réponse 4xx / 5xx suit l'enveloppe RFC 7807 problem-detail. Branchez sur le champ field — jamais sur des chaînes humaines ou des codes de statut seuls.

json
{
  "type": "https://api.alloovium.com/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "detail": "API key is missing required scope: vault:write",
  "code": "insufficient_scope",
  "missing_scopes": ["vault:write"]
}

Voir la liste complète des codes dans Erreurs.

6. Réessayer en toute sécurité

Pour les requêtes mutantes, attachez un header header. La même clé rejouée dans les 24 heures retourne la réponse originale — pas d'écritures dupliquées.

bash
curl -sS https://api.alloovium.com/api/v2/vault/projects \
  -H "Authorization: Bearer $ALLOOVIUM_API_KEY" \
  -H "Idempotency-Key: create-tower-2026-04-08" \
  -H "Content-Type: application/json" \
  -d '{"name": "Downtown Tower", "project_type": "commercial"}'

Étapes suivantes