Documentation développeurOpérationnellev1 · 2026-10-10

API ForenShield

Les outils d’investigation de ForenShield, en API : analysez un e-mail suspect, interrogez une base CVE enrichie (catalogue CISA KEV complet et CVE critiques et élevées récentes), examinez une URL suspecte et diagnostiquez un domaine (DNS, propagation, WHOIS), depuis vos scripts, votre SOAR ou votre SIEM. Une clé, des scopes par outil, un contrat stable.

API
4
API
du catalogue CISA KEV
100 %
du catalogue CISA KEV
profils navigateur
10
profils navigateur
contenu conservé
0
contenu conservé
URL de basehttps://api.forenshield.com
cURL
curl -X POST "https://api.forenshield.com/v1/eml/analyze?include=report" \
  -H "Authorization: Bearer $FORENSHIELD_API_KEY" \
  -H "Content-Type: message/rfc822" \
  --data-binary @suspect.eml
Réponse complète, exemples Python, Node.js et PowerShell : réservés aux membres.
Documentation· Introduction

Introduction

Les API sont des interfaces REST : requêtes HTTPS, réponses JSON UTF-8, codes HTTP standard. Elles exposent les mêmes moteurs que les outils du site, sans passer par le navigateur.

Catalogue des API

Chaque outil est une API à part entière, avec son scope : une clé n’ouvre que les API que vous lui accordez. Toutes partagent la même authentification, les mêmes limites, le même format d’erreur et le même document OpenAPI.

  • eml:analyze

    Analyse d’e-mails

    Verdict expliqué, SPF / DKIM / DMARC, liens, observables et routage d’un .eml suspect.

    • POST/v1/eml/analyze
    Référence
  • cve:read

    Base CVE

    Plus de 150 000 CVE enrichies : CVSS, CISA KEV, rançongiciels, PoC, produits et correctifs.

    • GET/v1/cve/search
    • GET/v1/cve/{id}
    • GET/v1/cve/stats
    Référence
  • sandbox:analyze

    Bac à sable URL

    URL suspecte examinée par plusieurs navigateurs : phishing, ClickFix, HTML smuggling, cloaking, MITRE ATT&CK.

    • POST/v1/sandbox/analyze
    Référence
  • network:diagnose

    Diagnostic réseau

    Résolution IP et ASN, DNS avec TTL réels, propagation sur 5 résolveurs, ping TCP et WHOIS (RDAP) depuis nos serveurs.

    • GET/v1/network/resolve
    • GET/v1/network/dns
    • GET/v1/network/propagation
    • GET/v1/network/ping
    • GET/v1/network/whois
    Référence
  • Sécurisée par conception

    Clés personnelles hachées (bcrypt), scopes par API, expiration, révocation immédiate. Jamais de clé dans une URL.

  • Rien n’est conservé

    E-mails, URL et pages sont analysés en mémoire puis oubliés. Le journal ne garde que l’endpoint, le statut et la durée (90 jours).

  • Contrat stable

    JSON en snake_case, versionné par date. Les ajouts sont rétrocompatibles ; toute rupture passera par /v2.

  • Pensée pour l’automatisation

    Erreurs typées, en-têtes de quota, identifiant de requête pour le support, exemples dans quatre langages.

Accès membres

La suite de la documentation est réservée aux membres

Connectez-vous, ou créez votre compte ForenShield en moins d’une minute, pour accéder à la référence complète des API et générer votre clé depuis le portail.

Ce que vous débloquez

  • La référence des 13 endpoints : paramètres, corps de requête, codes de réponse
  • Des exemples prêts à copier en cURL, Python, Node.js et PowerShell
  • Des réponses réelles et le détail de chaque objet de réponse
  • La console d’essai pour appeler les API en direct
  • Authentification, scopes, quotas et catalogue des erreurs
  • La spécification OpenAPI 3.1 et le journal des versions

Un compte client suffit. Vous revenez sur cette page juste après.

Questions fréquentes

L’API ForenShield est-elle gratuite ?

Oui : un compte client gratuit suffit pour créer une clé et appeler les quatre API, dans la limite de 3 requêtes par minute et 3 par jour. Les quotas dépendent de l’offre du compte et sont communs à toutes vos clés.

Quelles API sont disponibles ?

Quatre API REST : analyse d’e-mails (.eml : SPF, DKIM, DMARC, liens, observables, routage), base CVE (catalogue CISA KEV complet et CVE critiques et élevées récentes, avec CVSS, EPSS, rançongiciels et PoC), bac à sable d’URL (phishing, cloaking, indicateurs MITRE ATT&CK) et diagnostic réseau (résolution IP/ASN, DNS, propagation, ping TCP, WHOIS/RDAP).

Les e-mails et URL envoyés sont-ils conservés ?

Non. Le contenu est analysé en mémoire puis oublié. Le journal ne garde que l’endpoint appelé, le statut HTTP et la durée, pendant 90 jours.

Comment s’authentifier ?

Avec une clé personnelle créée depuis le portail, envoyée dans l’en-tête Authorization: Bearer ou X-API-Key. Chaque clé n’ouvre que les API dont elle a le scope, peut expirer et se révoque immédiatement. Une clé passée dans l’URL est refusée.

Existe-t-il une spécification OpenAPI ?

Oui : https://api.forenshield.com/v1/openapi.json décrit toutes les API en OpenAPI 3.1, sans authentification. Importez-la dans Postman, Insomnia, Bruno ou un générateur de client.

Que se passe-t-il en cas de dépassement de quota ?

L’API répond 429 avec l’en-tête Retry-After (secondes à attendre). Chaque réponse indique le quota restant (X-RateLimit-*, X-Quota-*) ; le quota journalier repart à zéro à minuit UTC.