Radar Spam API

v1.0.0
← Retour au site

Introduction

L'API Radar Spam vous permet de vérifier la réputation des numéros de téléphone en temps réel. Intégrez facilement notre service dans vos applications pour protéger votre entreprise du spam téléphonique.

⚡

Rapide

Vérification en moins de 200ms

🔒

Sécurisé

Authentification par clé API

📊

Analytics

Statistiques détaillées

Base URL

https://mvp.lead-aggregator.com/api/v1

Authentification

L'API utilise l'authentification par clé API. Chaque requête doit inclure votre clé API dans l'en-tête.

⚠️

Important

Gardez votre clé API secrète et ne la partagez jamais publiquement.

En-tête requis

X-API-Key: votre_cle_api_ici

Obtenir votre clé API

  1. Connectez-vous à votre tableau de bord
  2. Allez dans la section "API"
  3. Générez une nouvelle clé API
  4. Copiez et sauvegardez votre clé

Quotas et limites

Les quotas sont définis selon le rôle de l'utilisateur propriétaire de la clé API :

Rôle Quota quotidien Quota mensuel Description
👑 OWNER Illimité Illimité Accès complet sans restriction
👤 ADMIN 250 5,000 Administrateur avec quota standard
👤 MANAGER 250 5,000 Gestionnaire d'équipe
👤 AGENT 250 5,000 Agent standard
👤 USER 250 5,000 Utilisateur standard

Gestion des quotas

  • Quota quotidien : 250 vérifications par jour (renouvelé à minuit)
  • Quota mensuel : 5000 vérifications par mois (renouvelé le 1er du mois)
  • Partage : Les quotas sont partagés entre l'interface web et l'API REST
  • OWNER : Accès illimité sans restriction

Dépassement de quota

En cas de dépassement du quota quotidien ou mensuel, l'API retourne une erreur 429 Too Many Requests.

Endpoints

GET /health

Vérifier l'état de l'API

{
  "status": "healthy",
  "timestamp": "2024-01-15T10:30:00Z",
  "version": "1.0.0"
}
POST /verify

Vérifier la réputation d'un numéro de téléphone

Requête

{
  "phone_number": "+33123456789",
  "country_code": "FR",
  "include_details": true
}

Réponse

{
  "phone_number": "+33123456789",
  "country_code": "FR",
  "status": "SAFE",
  "risk_level": "LOW",
  "reputation_score": 85,
  "timestamp": "2024-01-15T10:30:00Z",
  "request_id": "12345",
  "details": {
    "spam_reports": 0,
    "last_seen": "2024-01-10T15:20:00Z",
    "carrier": "Orange",
    "line_type": "MOBILE"
  }
}
POST /verify/batch

Vérifier plusieurs numéros en lot (max 100)

Requête

{
  "phone_numbers": ["+33123456789", "+33987654321"],
  "country_code": "FR",
  "include_details": false
}

Réponse

{
  "results": [
    {
      "phone_number": "+33123456789",
      "status": "SAFE",
      "risk_level": "LOW",
      "reputation_score": 85
    },
    {
      "phone_number": "+33987654321",
      "status": "SPAM",
      "risk_level": "HIGH",
      "reputation_score": 15
    }
  ],
  "total_processed": 2,
  "timestamp": "2024-01-15T10:30:00Z"
}
GET /stats

Obtenir les statistiques d'utilisation

Paramètres

  • period - Période (7d, 30d, 90d) - Défaut: 30d

Réponse

{
  "period": "30d",
  "checks": {
    "total": 1250,
    "safe": 1100,
    "spam": 100,
    "suspicious": 50
  },
  "api_usage": {
    "total_requests": 1250,
    "successful_requests": 1200,
    "failed_requests": 50,
    "success_rate": 96.0
  },
  "quota": {
    "daily_limit": 833,
    "remaining_today": 650,
    "role": "ADMIN",
    "monthly_limit": 25000
  }
}

Exemples d'utilisation

cURL

Vérifier un numéro

curl -X POST https://mvp.lead-aggregator.com/api/v1/verify \
  -H "X-API-Key: votre_cle_api" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+33123456789",
    "country_code": "FR",
    "include_details": true
  }'

Vérification en lot

curl -X POST https://mvp.lead-aggregator.com/api/v1/verify/batch \
  -H "X-API-Key: votre_cle_api" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_numbers": ["+33123456789", "+33987654321"],
    "country_code": "FR"
  }'

JavaScript

// Vérifier un numéro
async function verifyNumber(phoneNumber) {
  const response = await fetch('https://mvp.lead-aggregator.com/api/v1/verify', {
    method: 'POST',
    headers: {
      'X-API-Key': 'votre_cle_api',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      phone_number: phoneNumber,
      country_code: 'FR',
      include_details: true
    })
  });
  
  const data = await response.json();
  return data;
}

// Utilisation
verifyNumber('+33123456789')
  .then(result => {
    console.log('Statut:', result.status);
    console.log('Score:', result.reputation_score);
  })
  .catch(error => {
    console.error('Erreur:', error);
  });

Python

import requests

def verify_number(phone_number, api_key):
    url = "https://mvp.lead-aggregator.com/api/v1/verify"
    headers = {
        "X-API-Key": api_key,
        "Content-Type": "application/json"
    }
    data = {
        "phone_number": phone_number,
        "country_code": "FR",
        "include_details": True
    }
    
    response = requests.post(url, headers=headers, json=data)
    return response.json()

# Utilisation
result = verify_number("+33123456789", "votre_cle_api")
print(f"Statut: {result['status']}")
print(f"Score: {result['reputation_score']}")

Codes d'erreur

Code Message Description
MISSING_API_KEY Clé API manquante L'en-tête X-API-Key est requis
INVALID_API_KEY Clé API invalide La clé API fournie n'est pas valide
QUOTA_EXCEEDED Quota dépassé Limite quotidienne atteinte
MISSING_PHONE Numéro manquant Le paramètre phone_number est requis
INVALID_BATCH_SIZE Taille de lot invalide Entre 1 et 100 numéros requis