Authentification

ReportedIP utilise l'authentification par clé API pour identifier les appelants et appliquer des limites de débit. Certains points de terminaison publics fonctionnent sans authentification, mais une clé API permet de bénéficier de limites plus élevées et de fonctionnalités supplémentaires.

Authentification par clé API

Incluez votre clé API dans chaque requête authentifiée. Il existe deux méthodes : la X-Key L'utilisation de l'en-tête est recommandée car elle permet d'éviter que votre clé n'apparaisse dans les journaux d'accès du serveur.

Méthode 1 : En-tête X-Key (recommandée)

curl -H "X-Key: YOUR_API_KEY" \
     "https://reportedip.de/wp-json/reportedip/v2/check?ip=1.2.3.4"

Méthode 2 : Paramètre de requête

curl "https://reportedip.de/wp-json/reportedip/v2/check?ip=1.2.3.4&key=YOUR_API_KEY"

Obtenir votre clé API

Suivez ces trois étapes pour obtenir votre clé API :

Rôles et autorisations des utilisateurs

Votre clé API est associée à votre rôle d'utilisateur. Chaque rôle dispose de limites de débit et d'un accès aux fonctionnalités différents. Lors de votre inscription, vous commencez avec le rôle « Gratuit ».

Limites de débit

Chaque réponse de l'API comprend des en-têtes de limitation de débit, ce qui vous permet de suivre votre utilisation en temps réel. Lorsque vous dépassez votre limite, l'API renvoie 429 Too Many Requests.

Exemples d'en-têtes de réponse

HTTP/1.1 200 OK
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 742
X-RateLimit-Reset: 1711929600
Content-Type: application/json; charset=UTF-8

Authentification hybride

Les points de terminaison publics tels que /check-public, /search-public, et /stats-public fonctionnent sans aucune authentification. Elles acceptent toutefois une clé API facultative permettant de bénéficier de limites de débit plus élevées.

# Without API key — 100 requests/day per IP
curl "https://reportedip.de/wp-json/reportedip/v2/check-public?ip=1.2.3.4"

# With API key — uses your role's daily limit
curl -H "X-Key: YOUR_API_KEY" \
     "https://reportedip.de/wp-json/reportedip/v2/check-public?ip=1.2.3.4"

Réponses d'erreur

Les erreurs d'authentification renvoient des réponses JSON standard. Vérifiez toujours meta.success et le code d'état HTTP.

401 Accès non autorisé

Renvoyé lorsque la clé API est manquante ou non valide.

{
  "meta": {
    "success": false,
    "code": 401,
    "message": "Invalid or missing API key."
  },
  "data": null
}

403 Accès interdit

Ce message s'affiche lorsque votre rôle ne dispose pas des autorisations nécessaires pour accéder au point de terminaison demandé.

{
  "meta": {
    "success": false,
    "code": 403,
    "message": "Your role does not have access to this endpoint."
  },
  "data": null
}

429 Nombre de requêtes trop élevé

Ce message s'affiche lorsque vous avez dépassé votre limite quotidienne.

{
  "meta": {
    "success": false,
    "code": 429,
    "message": "Rate limit exceeded. Try again later."
  },
  "data": {
    "retryAfter": 3600
  }
}

Bonnes pratiques