Documentation technique de l’API

Analyse de risques numériques

Introduction

Cette API est celle utilisée par le site ScamDoc.com lors d’une interrogation sur son formulaire principal. Depuis 2019, elle est mise à disposition de tiers souhaitant sécuriser leur(s) service(s).

Elle permet de récupérer 3 types d’informations :

  • Un score de confiance pour un mail donné (MailPredictor)
  • Un score de confiance pour un site internet (SitePredictor)
  • Les données Whois des sites internet (Whois Access)

Plus d’informations ici

Authentification (pré-requis à l’installation)

Pour utiliser l’API, vous avez besoin d’une clé : vous pouvez en avoir une gratuitement en créant un compte sur Scamdoc.com. Rendez-vous ensuite sur votre profil et demandez une clé en cliquant sur le bouton en bas de page. Vous recevrez alors la clé par email. Plus de détails sur cette page.

Cette clé API devra être insérée dans le header « x-api-key » de vos requêtes.

Mise en place

L’utilisation de l’API est simple : Il suffit d’utiliser une des requêtes HTTP suivantes pour obtenir une réponse au format JSON. Les requêtes doivent être envoyées en HTTPS par le biais d’une méthode GET. Attention, une authentification est nécessaire (décrite plus bas) !

Liste des requêtes de ScamPredictor

MailPredictor : Pour obtenir un score sur un mail

https://api.scampredictor.com/email/dupont@gmail.com

SitePredictor : Pour obtenir un score de confiance d’un site internet

https://api.scampredictor.com/domain/example.com

Whois Access : Pour obtenir les données whois

Cette offre est accessible uniquement à partir de la version « Pro ».

https://api.scampredictor.com/whois/example.com

Réponses

MailPredictor et SitePredictor

La réponse aura la forme suivante :

{ « class »: 3, « final_score »: 0.29000000000000004 }

Seul l’attribut « class » est présent en offre free.

La « class » désigne la catégorie de résultat :

  • « Class 1 » signifie que la ressource est sûre.
  • « Class 2 » signifie que la ressource est probablement sûre.
  • « Class 3 » signifie que notre fonction d’évaluation a des doutes.
  • « Class 4 » signifie que la ressource présente des risques.
  • « Class 5 » signifie que la ressource présente un haut niveau de risque.

« final_score » désigne une probabilité estimée que la ressource présente un danger. 0 signifie qu’elle est sûre, 1 signifie qu’elle est dangereuse.

Whois Access

Ce service renvoie une réponse dont le niveau de détail dépend directement de ce que nous délivre les annuaires whois des services d’enregistrements concernés. Le nombre de champs est donc particulièrement variable. Seul le champ « raw » qui représente les données brutes renvoyées par l’annuaire en question est systématiquement présent.

Codes erreur

  • Code 400 : Le formatage de votre requête est erroné. Vérifiez vos données d’entrée.
  • Code 403 : La clé d’API n’est pas valide ou la limite du nombre de requêtes a été atteint.
  • Code 500 : Erreur côté serveur. N’hésitez pas à nous contacter !

Limites et fonctionnalités

Les limites dépendent du plan choisi.