Bienvenue dans l’API Corgea

L’API Corgea vous permet d’interagir par programmation avec la plateforme de sécurité applicative de Corgea. Automatisez l’analyse des vulnérabilités, détectez les problèmes de sécurité, gérez les correctifs et intégrez Corgea à votre workflow de développement.

Que peut-on faire avec l’API Corgea ?

Gestion des scans

Lancer des scans de sécurité, charger leurs résultats et suivre leur progression

Findings et détections

Récupérer les vulnérabilités par scan ou à travers les scans, gérer leur statut et suivre leur remédiation

Récupération des correctifs automatiques

Accéder aux correctifs et patches de sécurité générés par l’IA pour les vulnérabilités détectées

Intégration CI/CD

Intégrez le scan de sécurité dans vos pipelines d’intégration continue

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.

API des findings

Récupérer les findings : une ligne par vulnérabilité à travers les scans, avec des filtres par projet, statut, urgence et changements depuis votre dernière synchronisation
Récupérer le détail d’un finding : l’état de triage d’une vulnérabilité et sa détection la plus récente
Triage en masse : changer le statut de findings par identifiant ou par règle

Un problème est la détection d’une vulnérabilité par un scan ; un finding est cette vulnérabilité à travers les scans. Findings et détections explique lequel utiliser. Chaque endpoint de gestion des problèmes est aussi servi sous /detections, par exemple GET /api/v1/detections pour GET /api/v1/issues. C’est la même API sous un nouveau nom, choisi pour qu’une détection ne soit pas confondue avec un finding. /issues reste pris en charge.

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

Toutes les requêtes d’API doivent être envoyées à l’une des URL suivantes : Notre environnement multi-locataire

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

Ou votre instance monolocataire ou régionale (par exemple eu.corgea.app)

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

Utilisez le même hôte que celui affiché dans votre navigateur lorsque vous vous connectez à Corgea. Les jetons d’API ne fonctionnent que sur l’instance où ils ont été créés : un jeton valide envoyé à une autre instance est refusé comme invalide.

Authentification

L’API Corgea utilise une authentification par clé API. Ajoutez votre token d’API à l’en-tête de la requête :

CORGEA-TOKEN: your_api_token_here

Bien démarrer avec l’authentification

Obtenir un token d’API : récupérez-le dans Settings → Automation → API token
Vérifier votre token : utilisez l’endpoint /verify pour confirmer sa validité
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

Authentification par en-tête (recommandée) :

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

Authentification par chemin (obsolète) :

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

Flux d’autorisation

Pour les applications qui doivent authentifier les utilisateurs :

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

Certains endpoints, tels que /verify/{token} et /authorize, ne nécessitent pas d’authentification. Consultez la documentation de chaque endpoint pour connaître ses exigences.

Format de réponse

Toutes les réponses de l’API sont au format JSON. Les réponses réussies contiennent un champ status :

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

Les réponses à l’erreur incluent des messages descriptifs :

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

Codes de statut HTTP

L’API utilise les codes de statut HTTP standard :

Code	Description
`200`	Demande réussie
`400`	Requête incorrecte : paramètres ou corps non valides
`401`	Non autorisé : authentification non valide ou manquante
`404`	Ressource non trouvée
`429`	Limite de débit dépassée
`500`	Erreur interne du serveur

Pagination

Les endpoints qui renvoient des listes prennent en charge la pagination au moyen de paramètres de requête :

page: Numéro de page (par défaut : 1)
page_size: Nombre de résultats par page (par défaut : 20, max : 50 ; GET /findings accepte jusqu’à 100)

Les réponses paginées contiennent :

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

Besoin d’aide ?

Guide d’authentification

Découvrez comment authentifier vos requêtes d’API

Assistance

Contactez notre équipe de support pour obtenir de l’aide

Démarrage rapide

Commencez à utiliser l’API Corgea en trois étapes :

Récupérez votre token d’API dans Settings → Automation → API token
Vérifiez votre token avec l’endpoint /verify et l’authentification par en-tête
Envoyez votre première requête pour téléverser un rapport d’analyse ou lister les problèmes de sécurité

Explorez les endpoints de l’API dans la barre latérale pour découvrir les fonctionnalités disponibles.

​Bienvenue dans l’API Corgea

​Que peut-on faire avec l’API Corgea ?

Gestion des scans

Findings et détections

Récupération des correctifs automatiques

Intégration CI/CD

​Fonctionnalités de l’API

​Authentification et autorisation

​API de scan

​API de gestion des problèmes

​API des findings

​Gestion des politiques

​Base URL

​Authentification

​Bien démarrer avec l’authentification

​Méthodes d’authentification

​Flux d’autorisation

​Format de réponse

​Codes de statut HTTP

​Pagination

​Besoin d’aide ?

Guide d’authentification

Assistance

​Démarrage rapide

Bienvenue dans l’API Corgea

Que peut-on faire avec l’API Corgea ?

Fonctionnalités de l’API

Authentification et autorisation

API de scan

API de gestion des problèmes

API des findings

Gestion des politiques

Base URL

Authentification

Bien démarrer avec l’authentification

Méthodes d’authentification

Flux d’autorisation

Format de réponse

Codes de statut HTTP

Pagination

Besoin d’aide ?

Démarrage rapide