Skip to content

Autoriser votre serveur à lancer des analyses

Préparez une clé API rattachée à votre application, dotée des droits antivirus, et vérifiez que le client dispose de crédits.

GuideDeveloper
Required access
Droits « Lancer un scan antivirus » et « Voir le module antivirus »
Duration
10 min

This page has not been translated yet and is shown in French.

L'API antivirus vérifie trois choses à chaque appel : l'identité de l'appelant, ses droits applicatifs et le solde de crédits de son client. Ce guide prépare les trois, une fois pour toutes, avant votre premier envoi.

Avant de commencer

  • Votre application existe sur Wakastart. Elle est créée par Wakastart ; contactez-nous pour en ouvrir une.
  • Vous pouvez créer des clés API et gérer les profils de votre client. Voir Clés API et Droits et profils.

Choisir le mode d'authentification

L'API publique accepte deux façons de s'authentifier pour l'antivirus :

ModeEn-têteQuand l'utiliser
Clé APIx-api-key: sk_…Votre serveur envoie les fichiers en son nom propre. Recommandé.
Jeton de l'utilisateurAuthorization: Bearer <jeton>Votre serveur relaie la demande d'un utilisateur connecté, avec le jeton Keycloak émis pour votre application.

Dans les deux cas, l'appel doit porter un client et une application. Une clé API sans application rattachée est refusée par l'antivirus.

Donner les droits antivirus

Deux droits applicatifs gouvernent l'antivirus :

Droit affichéCodePermet
Lancer un scan antivirusantivirus.scanEnvoyer un fichier : POST /api/antivirus/scans
Voir le module antivirusantivirus.readLire le statut et le détail d'un scan
  1. Dans la console, ouvrez le profil que portera la clé API (ou l'utilisateur).
  2. Ajoutez les droits Lancer un scan antivirus et Voir le module antivirus.
  3. Enregistrez le profil.

Résultat : toute clé ou tout utilisateur portant ce profil peut envoyer des fichiers et suivre leurs analyses.

Créer la clé API

  1. Créez une clé API rattachée à votre client et à votre application, avec le profil préparé à l'étape précédente. La procédure complète est dans Clés API.
  2. Copiez la valeur sk_… affichée : elle n'est montrée qu'une fois.
  3. Rangez-la dans le gestionnaire de secrets de votre serveur, jamais dans le code ni dans une application mobile ou un navigateur.

Vérifier le solde de crédits

Chaque analyse consomme 1 crédit sur le solde du client rattaché à la clé. Consultez ce solde et rechargez-le si besoin depuis Crédits. Sans crédit, l'envoi est refusé avec une erreur 402.

Vérifier le résultat

Envoyez un petit fichier de test :

Bash
curl -X POST "https://api.wakastart.app/api/antivirus/scans" \
  -H "x-api-key: sk_test_exemple" \
  -F "file=@test.txt"

Une réponse 201 avec "status": "PENDING" confirme que l'authentification, les droits et les crédits sont en place. Les autres réponses sont expliquées dans le dépannage :

  • 401 : la clé est absente ou invalide ;
  • 403 avec Droit applicatif requis : antivirus.scan : le profil de la clé n'a pas le droit ;
  • 402 : le solde de crédits est vide.

Voir aussi