​

Bienvenue dans l’API Corgea

​

Que peut-on faire avec l’API Corgea ?

​

Fonctionnalités de l’API

​

Authentification et autorisation

• Vérification des tokens : vérifier les tokens d’API et récupérer les informations de l’utilisateur
• Flux d’autorisation : échanger des codes d’autorisation contre des tokens d’API

​

API de scan

• Démarrer un scan : lancer de nouveaux scans BLAST avec un chargement de fichiers par blocs pour les grands volumes de code
• Charger les résultats d’un scan : envoyer les rapports d’outils de sécurité externes
• Récupérer les scans : consulter l’historique avec filtres et pagination
• Récupérer le détail d’un scan : accéder aux informations détaillées d’un scan
• Rapports de scan : générer des rapports HTML, SARIF ou Markdown

​

API de gestion des problèmes

• Récupérer les problèmes : répertorier tous les problèmes de sécurité avec des options de filtrage
• Récupérer le détail d’un problème : obtenir toutes les informations sur une vulnérabilité
• Problèmes SCA : accéder aux vulnérabilités détectées par l’analyse de composition logicielle (SCA)
• Filtrage des problèmes : filtrer par projet, dépôt, urgence, etc.

​

Gestion des politiques

• Règles de blocage: Définir et gérer les politiques de sécurité
• Validation des règles: Vérifiez si les scans enfreignent les règles de blocage
• Application des politiques: Empêcher les déploiements basés sur des politiques de sécurité

​

Base URL

https://www.corgea.app/api/v1

https://<your-instance>.corgea.app/api/v1

​

Authentification

CORGEA-TOKEN: your_api_token_here

​

Bien démarrer avec l’authentification

1. Obtenir un token d’API : récupérez-le dans les paramètres de votre compte Corgea
2. Vérifier votre token : utilisez l’endpoint /verify pour confirmer sa validité
3. Récupérer éventuellement les informations de l’utilisateur : ajoutez ?user_info=true pour obtenir les informations de l’utilisateur et de l’entreprise

​

Méthodes d’authentification

curl -H "CORGEA-TOKEN: your_api_token_here" \
     https://www.corgea.app/api/v1/verify

curl https://www.corgea.app/api/v1/verify/your_token_here

​

Flux d’autorisation

1. Redirigez les utilisateurs vers la page d’autorisation de Corgea
2. Les utilisateurs autorisent votre application et reçoivent un code d’autorisation
3. Échangez le code contre un token d’API avec /authorize?code=your_code

​

Format de réponse

{
  "status": "ok",
  "data": { }
}

{
  "status": "error",
  "message": "Description of the error"
}

​

Codes de statut HTTP

​

Pagination

• page: Numéro de page (par défaut : 1)
• page_size: Nombre de résultats par page (par défaut : 20, max : 50)

{
  "status": "ok",
  "page": 1,
  "total_pages": 5,
  "data": []
}

​

Besoin d’aide ?

​

Démarrage rapide

1. Récupérez votre token d’API dans les paramètres de votre compte Corgea
2. Vérifiez votre token avec l’endpoint /verify et l’authentification par en-tête
3. Envoyez votre première requête pour téléverser un rapport d’analyse ou lister les problèmes de sécurité