DevScout

Documentación para Socios

DevScout Partner API

Esta documentación describe cómo integrar tu plataforma con DevScout para verificar, en tiempo real, si un usuario es suscriptor activo, permitiéndote conceder descuentos y beneficios exclusivos de forma automática y segura.

REST APIJSONRate limit: 60 req/min

Cómo funciona

Cada suscriptor de DevScout posee un código de verificación único (UUID) visible en su panel. El flujo de verificación es:

  1. 1El usuario accede a tu plataforma e informa su código de verificación DevScout.
  2. 2Tu plataforma llama a nuestro endpoint GET /api/verify/subscriber enviando el código + tu API Key en el header.
  3. 3Recibes la respuesta: si es suscriptor activo, qué plan y hasta cuándo.
  4. 4Tu plataforma concede el descuento o beneficio correspondiente.

Autenticación

Toda solicitud debe incluir tu API Key de socio en el header X-Partner-Key. La clave la proporciona el equipo DevScout tras registrar tu plataforma como socia.

http header
X-Partner-Key: tu_api_key_aqui

Nunca expongas tu API Key en el front-end. Haz siempre la llamada desde tu servidor (server-side) para proteger la clave.

Endpoint de Verificación

GEThttps://api.devscout.app/api/verify/subscriber

Query Parameters

codeEl código de verificación UUID del usuario (obligatorio)

Headers

X-Partner-KeyTu API Key de socio (obligatorio)

Ejemplos de Solicitud

curl
curl -X GET \
  "https://api.devscout.app/api/verify/subscriber?code=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-Partner-Key: tu_api_key_aqui"
javascript (Node.js)
const response = await fetch(
  'https://api.devscout.app/api/verify/subscriber?code=' + userCode,
  {
    headers: {
      'X-Partner-Key': process.env.DEVSCOUT_PARTNER_KEY,
    },
  }
);

const data = await response.json();

if (data.is_subscriber) {
  // Conceder el descuento
  console.log('Plan:', data.plan_name);
  console.log('Válido hasta:', data.valid_until);
} else {
  console.log('El usuario no es suscriptor activo');
}
python
import requests
import os

response = requests.get(
    'https://api.devscout.app/api/verify/subscriber',
    params={'code': user_code},
    headers={'X-Partner-Key': os.getenv('DEVSCOUT_PARTNER_KEY')}
)

data = response.json()

if data.get('is_subscriber'):
    print(f"Plan: {data['plan_name']}")
    print(f"Válido hasta: {data['valid_until']}")

Respuesta

Suscriptor activo

json (HTTP 200)
{
  "success": true,
  "is_subscriber": true,
  "plan_slug": "scout-master",
  "plan_name": "Scout Master",
  "valid_until": "2025-06-01T00:00:00",
  "user_name": "joao_dev"
}

No suscriptor (plan free)

json (HTTP 200)
{
  "success": true,
  "is_subscriber": false,
  "plan_slug": "scout-free",
  "plan_name": "Scout Free",
  "valid_until": null,
  "user_name": "joao_dev"
}

Código inválido o API Key inválida

json (HTTP 401)
{
  "success": false,
  "is_subscriber": false,
  "error": "Invalid verification code or partner key"
}

Campos de la respuesta

success·boolean

true si la solicitud fue procesada con éxito

is_subscriber·boolean

true si el usuario posee una suscripción activa (no free)

plan_slug·string

Identificador del plan: scout-free, scout-explorer, scout-master

plan_name·string

Nombre legible del plan

valid_until·string | null

Fecha ISO de expiración de la suscripción

user_name·string

Nombre de usuario DevScout (para confirmación)

Límites y Buenas Prácticas

Rate limit

60 solicitudes por minuto por API Key. Implementa caché de corta duración (ej.: 5 minutos) para evitar llamadas innecesarias.

Nunca expongas la API Key

Haz la llamada siempre server-side (backend). Nunca en el front-end ni en apps móviles.

Valida el user_name

Para mayor seguridad, pide al usuario que confirme su username DevScout y compáralo con el user_name devuelto.

Maneja los errores con gracia

Si nuestra API no está disponible (HTTP 5xx), considera permitir el acceso temporalmente y reintentar más tarde.

Convertirse en Socio

¿Interesado en ofrecer beneficios exclusivos a los suscriptores de DevScout? Contacta a nuestro equipo para obtener tu API Key y aparecer en el panel de socios.

Contactar