Autenticación

ReportedIP utiliza la autenticación mediante clave API para identificar a los usuarios que realizan llamadas y aplicar los límites de frecuencia. Algunos puntos de conexión públicos funcionan sin autenticación, pero una clave API permite acceder a límites más altos y a funciones adicionales.

Autenticación mediante clave API

Incluye tu clave API en cada solicitud autenticada. Hay dos métodos: el X-Key Se recomienda utilizar el encabezado porque mantiene tu clave fuera de los registros de acceso del servidor.

Método 1: Encabezado X-Key (recomendado)

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

Método 2: Parámetro de consulta

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

Cómo obtener tu clave API

Sigue estos tres pasos para obtener tu clave API:

Roles y permisos de usuario

Tu clave API está vinculada a tu rol de usuario. Cada rol tiene diferentes límites de frecuencia y acceso a funciones. Al registrarte, se te asigna el rol «Gratuito ».

Límites de frecuencia

Todas las respuestas de la API incluyen encabezados de limitación de frecuencia para que puedas hacer un seguimiento de tu uso en tiempo real. Cuando superas el límite, la API responde con 429 Too Many Requests.

Ejemplos de encabezados de respuesta

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

Autenticación híbrida

Puntos finales públicos como /check-public, /search-public, y /stats-public funcionan sin necesidad de autenticación. No obstante, admiten una clave API opcional para ampliar los límites de frecuencia.

# 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"

Respuestas de error

Los errores de autenticación devuelven respuestas JSON estándar. Compruébalo siempre meta.success y el código de estado HTTP.

401 Acceso no autorizado

Se devuelve cuando falta la clave API o esta no es válida.

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

403 Prohibido

Se devuelve cuando tu rol no tiene permiso para el punto final solicitado.

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

429 Demasiadas solicitudes

Se muestra cuando se ha superado el límite diario.

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

Buenas prácticas