Para desarrolladores

Documentación API y MCP

Referencia completa para desarrolladores

322 rutas documentadas en 39 categorías
Contenido
MCP · Asistentes de IA

Conecta tu asistente de IA a ScreenLeads

El servidor MCP permite que Claude u otro cliente compatible consulte tus datos de ScreenLeads hablando en lenguaje natural, con los permisos de tu credencial.

Datos de conexión

Endpoint MCP
https://mcp.pre.screenleads.com/mcp

Transporte HTTP (JSON-RPC).

Health check
https://mcp.pre.screenleads.com/health

Debe devolver ok: true y backendAuthMode: passthrough.

Entorno backend
https://api.pre.screenleads.com

El MCP reenvía tu credencial a la API en modo passthrough.

Modo de seguridad
passthrough

El MCP no guarda credenciales globales: tu asistente solo ve lo que tu API key puede ver.

Ponlo en marcha en 4 pasos

  1. 1
    Comprueba el health check

    Ábrelo en el navegador y confirma que devuelve ok: true.

  2. 2
    Configura tu cliente MCP

    Registra el servidor con la URL /mcp y las cabeceras Authorization (Bearer con tu API key) y X-ScreenLeads-Client-Id. Algunos clientes gestionan las cabeceras desde su interfaz en vez de JSON.

  3. 3
    Lista las herramientas

    Comprueba que aparecen tools de empresas, branding, dispositivos, anuncios, promociones, planes, tokens, facturas, media y webhooks.

  4. 4
    Lanza una consulta real

    Por ejemplo screenleads_health_check, o pregunta en lenguaje natural qué permisos tiene tu API key.

Configuración y ejemplos

Configuración del cliente MCP (JSON)
{
  "mcpServers": {
    "screenleads": {
      "url": "https://mcp.pre.screenleads.com/mcp",
      "headers": {
        "Authorization": "Bearer <SCREENLEADS_API_KEY>",
        "X-ScreenLeads-Client-Id": "<SCREENLEADS_CLIENT_ID>"
      }
    }
  }
}
cURL · Consulta autenticada
curl -X POST https://mcp.pre.screenleads.com/mcp \
  -H 'Authorization: Bearer <SCREENLEADS_API_KEY>' \
  -H 'X-ScreenLeads-Client-Id: <SCREENLEADS_CLIENT_ID>' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  --data '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": { "name": "screenleads_health_check", "arguments": {} }
  }'

Qué puede consultar tu asistente

Empresas y branding

Empresas visibles, logos y tokens de marca.

Dispositivos y anuncios

Pantallas, anuncios asignados y diagnóstico de reproducción.

Promociones

Promociones activas, códigos QR, activación y desactivación.

Planes y tokens

Planes visibles, packs de tokens, balance y movimientos.

Facturación

Facturas visibles de tu empresa y cobros recientes.

Webhooks y permisos

Integraciones configuradas y scopes de tu API key.

Pruébalo con estas preguntas

  • ¿Qué permisos tiene mi API key y puede escribir anuncios?
  • Lista las empresas que puede ver mi usuario.
  • Revisa qué anuncios tiene asignados el dispositivo 1 y si hay promociones vinculadas.
  • Calcula el balance actual de tokens y lista los últimos movimientos.
  • Prepara el cambio del anuncio 15, pero no lo ejecutes hasta que te confirme.

Seguridad y alcance

  • Modo passthrough: tu credencial se reenvía a la API; el MCP no guarda credenciales globales de administrador.
  • Tu asistente solo puede consultar lo que tu API key puede consultar en el backend.
  • Las escrituras van en dos pasos: el MCP devuelve una previsualización y solo ejecuta si confirmas explícitamente.
  • Tokens, contraseñas y secretos se redactan en las respuestas del MCP.
API REST

Integra la API de ScreenLeads

Empresas, dispositivos, anuncios, promociones, planes, tokens y facturas — siempre con los permisos de tu credencial.

Datos de conexión

Entorno backend (PRE)
https://api.pre.screenleads.com

Entorno de preproducción para validar tu integración antes de pasar a producción.

Autenticación
X-API-KEY + X-ScreenLeads-Client-Id

API key de ScreenLeads acotada a tu cliente o empresa. También se acepta como Authorization: Bearer.

Cómo obtener tu credencial

  1. 1
    Crea o selecciona un cliente API

    Desde ScreenLeads, el cliente API representa tu integración.

  2. 2
    Crea una API key con scopes

    De lectura o escritura y, si aplica, acotada a una empresa (companyScope).

  3. 3
    Guarda rawKey y client_id

    Son los dos únicos datos que necesita tu integración; no hace falta login recurrente. La key se puede revocar o rotar desde el backend.

  4. 4
    Llama a la API con las dos cabeceras

    Envía la API key y el client_id en cada petición.

Ejemplos

cURL · Petición con API key
curl https://api.pre.screenleads.com/companies \
  -H 'X-API-KEY: <SCREENLEADS_API_KEY>' \
  -H 'X-ScreenLeads-Client-Id: <SCREENLEADS_CLIENT_ID>'
cURL · Login JWT (solo pruebas internas)
curl -X POST https://api.pre.screenleads.com/auth/login \
  -H 'Content-Type: application/json' \
  --data '{"username":"usuario@screenleads.com","password":"PASSWORD"}'

Seguridad

  • Usa una API key acotada al cliente o empresa: se revoca o rota sin caída ni cierre de sesiones.
  • No pegues API keys, tokens ni contraseñas en chats, documentos compartidos o capturas.
  • El JWT de login funciona, pero caduca y depende de una sesión de usuario: resérvalo para pruebas internas.

role-controller

6 endpoints
get/roles

list_2

cURL
curl -X GET "https://api.pre.screenleads.com/roles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/roles

create_1

cURL
curl -X POST "https://api.pre.screenleads.com/roles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/roles/{id}

get_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/roles/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/roles/{id}

update_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/roles/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/roles/{id}

delete_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/roles/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/roles/assignable

assignable

cURL
curl -X GET "https://api.pre.screenleads.com/roles/assignable" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

user-controller

5 endpoints
get/users

list_1

cURL
curl -X GET "https://api.pre.screenleads.com/users" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/users

create

cURL
curl -X POST "https://api.pre.screenleads.com/users" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/users/{id}

get

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/users/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/users/{id}

update

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/users/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/users/{id}

delete

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/users/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

media-controller

8 endpoints
get/medias

getAllMedias

cURL
curl -X GET "https://api.pre.screenleads.com/medias" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/medias

createMedia

cURL
curl -X POST "https://api.pre.screenleads.com/medias" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/medias/{id}

getMediaById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/medias/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/medias/{id}

updateMedia

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/medias/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/medias/{id}

deleteMedia

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/medias/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/medias/upload

upload

cURL
curl -X POST "https://api.pre.screenleads.com/medias/upload" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/medias/render/{id}

getImage

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/medias/render/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/medias/upload-from-url

uploadFromUrl

cURL
curl -X POST "https://api.pre.screenleads.com/medias/upload-from-url" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Advices

6 endpoints

Gestión y consulta de anuncios (advices)

get/advices

Listar todos los advices

cURL
curl -X GET "https://api.pre.screenleads.com/advices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/advices

Crear un advice

cURL
curl -X POST "https://api.pre.screenleads.com/advices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/advices/{id}

Obtener un advice por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/advices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/advices/{id}

Actualizar un advice

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/advices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/advices/{id}

Eliminar un advice

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/advices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/advices/visibles

Advices visibles ahora

Filtra por la zona horaria indicada por cabeceras X-Timezone o X-Timezone-Offset

Parámetros
  • X-Timezoneheaderstring

    Zona horaria IANA, p.ej. Europe/Madrid

  • X-Timezone-Offsetheaderstring

    Minutos al ESTE de UTC, p.ej. 120

cURL
curl -X GET "https://api.pre.screenleads.com/advices/visibles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Auth

9 endpoints

Autenticación y cuentas de usuario

get/auth/me

Usuario actual (requiere token)

cURL
curl -X GET "https://api.pre.screenleads.com/auth/me" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/login

Login

Devuelve access/refresh token y datos básicos del usuario

cURL
curl -X POST "https://api.pre.screenleads.com/auth/login" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/refresh

Refresh token (requiere token)

cURL
curl -X POST "https://api.pre.screenleads.com/auth/refresh" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/register

Registro de usuario

cURL
curl -X POST "https://api.pre.screenleads.com/auth/register" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/reset-password

Restablecer contraseña

Establece nueva contraseña usando token válido

cURL
curl -X POST "https://api.pre.screenleads.com/auth/reset-password" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/change-password

Cambiar contraseña

cURL
curl -X POST "https://api.pre.screenleads.com/auth/change-password" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/forgot-password

Solicitar recuperación de contraseña

Envía un email con enlace para restablecer contraseña

cURL
curl -X POST "https://api.pre.screenleads.com/auth/forgot-password" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/auth/accept-invitation

Aceptar invitación y crear cuenta

Completa el registro usando un token de invitación válido

cURL
curl -X POST "https://api.pre.screenleads.com/auth/accept-invitation" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/auth/verify-reset-token

Verificar validez de token de reset

Comprueba si un token es válido, no expirado y no usado

Parámetros
  • tokenquerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/auth/verify-reset-token" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

client-controller

7 endpoints
get/clients

listClients

cURL
curl -X GET "https://api.pre.screenleads.com/clients" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/clients

createClient

cURL
curl -X POST "https://api.pre.screenleads.com/clients" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/clients/{id}

getClient

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/clients/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/clients/{id}

updateClient

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/clients/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/clients/{id}

deleteClient

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/clients/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/clients/{id}/activate

activateClient

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/clients/{id}/activate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/clients/{id}/deactivate

deactivateClient

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/clients/{id}/deactivate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Coupons

5 endpoints

Validación y canje de cupones de promociones

get/coupons

Listar todos los cupones

Devuelve todos los promotion redemptions (cupones)

cURL
curl -X GET "https://api.pre.screenleads.com/coupons" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/coupons/issue

Emitir cupón (crear lead histórico)

Genera un nuevo cupón interno para un cliente y una promoción desde un dispositivo, respetando límites

Parámetros
  • promotionIdqueryintegerObligatorio
  • customerIdqueryintegerObligatorio
  • deviceIdqueryintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/coupons/issue" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/coupons/{code}

Validar cupón por código

Devuelve el estado y si es válido en este momento

Parámetros
  • codepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/coupons/{code}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/coupons/{code}/expire

Caducar cupón por código

Marca el cupón como EXPIRED si aún no se ha canjeado

Parámetros
  • codepathstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/coupons/{code}/expire" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/coupons/{code}/redeem

Canjear cupón por código

Marca el cupón como REDEEMED si es válido

Parámetros
  • codepathstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/coupons/{code}/redeem" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Devices

10 endpoints

CRUD de dispositivos y gestión de advices por dispositivo

get/devices

Listar dispositivos

cURL
curl -X GET "https://api.pre.screenleads.com/devices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/devices

Crear dispositivo (auto-registro público)

cURL
curl -X POST "https://api.pre.screenleads.com/devices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/devices/{id}

Obtener dispositivo por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/devices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/devices/{id}

Actualizar dispositivo

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/devices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/devices/{id}

Eliminar dispositivo

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/devices/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/devices/uuid/{uuid}

Obtener dispositivo por UUID (público)

Parámetros
  • uuidpathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/devices/uuid/{uuid}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
head/devices/uuid/{uuid}

Comprobar existencia de dispositivo por UUID

Devuelve 200 si existe, 404 si no

Parámetros
  • uuidpathstringObligatorio
cURL
curl -X HEAD "https://api.pre.screenleads.com/devices/uuid/{uuid}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/devices/{deviceId}/advices

Listar advices asignados a un dispositivo

Parámetros
  • deviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/devices/{deviceId}/advices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/devices/{deviceId}/advices/{adviceId}

Asignar un advice a un dispositivo

Parámetros
  • deviceIdpathintegerObligatorio
  • adviceIdpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/devices/{deviceId}/advices/{adviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/devices/{deviceId}/advices/{adviceId}

Quitar un advice de un dispositivo

Parámetros
  • deviceIdpathintegerObligatorio
  • adviceIdpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/devices/{deviceId}/advices/{adviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

api-key-controller

13 endpoints
get/api-keys

getAllApiKeys

cURL
curl -X GET "https://api.pre.screenleads.com/api-keys" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api-keys

createApiKey

cURL
curl -X POST "https://api.pre.screenleads.com/api-keys" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api-keys/{id}

getApiKeyById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api-keys/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api-keys/{id}

updateApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api-keys/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api-keys/{id}

deleteApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api-keys/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api-keys/{id}/revoke

revokeApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api-keys/{id}/revoke" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api-keys/{id}/rotate

rotateApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api-keys/{id}/rotate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api-keys/{id}/scopes

updateScopes

Parámetros
  • idpathintegerObligatorio
  • scopesquerystringObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api-keys/{id}/scopes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api-keys/{id}/activate

activateApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api-keys/{id}/activate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api-keys/{id}/deactivate

deactivateApiKey

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api-keys/{id}/deactivate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api-keys/{id}/description

updateDescription_1

Parámetros
  • idpathintegerObligatorio
  • descriptionquerystringObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api-keys/{id}/description" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api-keys/{id}/company-scope

updateCompanyScope

Parámetros
  • idpathintegerObligatorio
  • companyScopequeryinteger
cURL
curl -X PATCH "https://api.pre.screenleads.com/api-keys/{id}/company-scope" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api-keys/client/{clientDbId}

getApiKeysByClient

Parámetros
  • clientDbIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api-keys/client/{clientDbId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

app-entity-controller

8 endpoints
get/entities

list

Parámetros
  • withCountqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/entities" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/entities

upsert

cURL
curl -X PUT "https://api.pre.screenleads.com/entities" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/entities/{id}

getById

Parámetros
  • idpathintegerObligatorio
  • withCountqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/entities/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/entities/{id}

update_2

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/entities/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/entities/{id}

delete_2

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/entities/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/entities/reorder

reorderEntities

cURL
curl -X PUT "https://api.pre.screenleads.com/entities/reorder" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/entities/by-resource/{resource}

getByResource

Parámetros
  • resourcepathstringObligatorio
  • withCountqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/entities/by-resource/{resource}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/entities/{id}/attributes/reorder

reorderAttributes

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/entities/{id}/attributes/reorder" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Companies

8 endpoints

CRUD de compañías

get/companies

Listar compañías

cURL
curl -X GET "https://api.pre.screenleads.com/companies" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/companies

Crear compañía

ROLE_ADMIN o permiso company:write

cURL
curl -X POST "https://api.pre.screenleads.com/companies" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/companies/{id}

Obtener compañía por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/companies/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/companies/{id}

Actualizar compañía

ROLE_ADMIN o permiso company:write

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/companies/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/companies/{id}

Eliminar compañía

ROLE_ADMIN o permiso company:delete

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/companies/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/companies/{id}/sync-stripe

Sincronizar datos de Stripe

Busca el customer en Stripe y sincroniza subscripción

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/companies/{id}/sync-stripe" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/companies/{id}/create-billing-portal

Crear sesión del Billing Portal

Genera URL del portal de facturación de Stripe

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/companies/{id}/create-billing-portal" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/companies/{id}/create-checkout-session

Crear sesión de Stripe Checkout

Genera URL de Stripe Checkout para configurar método de pago

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/companies/{id}/create-checkout-session" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

web-socket-status-controller

1 endpoint
get/ws/status

getActiveRooms

cURL
curl -X GET "https://api.pre.screenleads.com/ws/status" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

promotions-controller

10 endpoints
get/promotions

getAllPromotions

cURL
curl -X GET "https://api.pre.screenleads.com/promotions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/promotions

createPromotion

cURL
curl -X POST "https://api.pre.screenleads.com/promotions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotions/{id}

getPromotionById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/promotions/{id}

updatePromotion

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/promotions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/promotions/{id}

deletePromotion

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/promotions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotions/{id}/leads

listLeads

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotions/{id}/leads" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/promotions/{id}/leads

registerLead

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/promotions/{id}/leads" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/promotions/{id}/leads/test

createTestLead

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/promotions/{id}/leads/test" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotions/{id}/leads/summary

getLeadSummary

Parámetros
  • idpathintegerObligatorio
  • fromquerystring
  • toquerystring
cURL
curl -X GET "https://api.pre.screenleads.com/promotions/{id}/leads/summary" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotions/{id}/leads/export.csv

exportLeadsCsv

Parámetros
  • idpathintegerObligatorio
  • fromquerystring
  • toquerystring
cURL
curl -X GET "https://api.pre.screenleads.com/promotions/{id}/leads/export.csv" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

App Versions

6 endpoints

Gestión de versiones de la app por plataforma

get/app-versions

Listar versiones

cURL
curl -X GET "https://api.pre.screenleads.com/app-versions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/app-versions

Crear versión

cURL
curl -X POST "https://api.pre.screenleads.com/app-versions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/app-versions/{id}

Obtener versión por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/app-versions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/app-versions/{id}

Actualizar versión por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/app-versions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/app-versions/{id}

Eliminar versión por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/app-versions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/app-versions/latest/{platform}

Última versión por plataforma

Parámetros
  • platformpathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/app-versions/latest/{platform}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

media-types-controller

5 endpoints
get/medias/types

getAllMediaTypes

cURL
curl -X GET "https://api.pre.screenleads.com/medias/types" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/medias/types

createMediaType

cURL
curl -X POST "https://api.pre.screenleads.com/medias/types" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/medias/types/{id}

getMediaTypeById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/medias/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/medias/types/{id}

updateMediaType

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/medias/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/medias/types/{id}

deleteMediaType

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/medias/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Announcements

11 endpoints

Gestión de anuncios (alias de Advices)

get/announcements

Listar todos los anuncios

cURL
curl -X GET "https://api.pre.screenleads.com/announcements" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/announcements

Crear nuevo anuncio

cURL
curl -X POST "https://api.pre.screenleads.com/announcements" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/announcements/{id}

Obtener anuncio por ID

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/announcements/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/announcements/{id}

Actualizar anuncio

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/announcements/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/announcements/{id}

Eliminar anuncio

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/announcements/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/announcements/visibles

Anuncios visibles ahora

Devuelve anuncios activos en la zona horaria del cliente (headers X-Timezone o X-Timezone-Offset)

Parámetros
  • X-Timezoneheaderstring

    IANA Timezone, ej: 'Europe/Madrid'

  • X-Timezone-Offsetheaderinteger

    Offset en minutos al ESTE de UTC, ej: 120

cURL
curl -X GET "https://api.pre.screenleads.com/announcements/visibles" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/announcements/client/{clientId}

Obtener anuncios por cliente publicitario

Parámetros
  • clientIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/announcements/client/{clientId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/announcements/company/{companyId}

Obtener anuncios por compañía

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/announcements/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/announcements/{announcementId}/devices

Obtener dispositivos asignados a un anuncio

Parámetros
  • announcementIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/announcements/{announcementId}/devices" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/announcements/{announcementId}/devices/{deviceId}

Asignar un dispositivo a un anuncio

Parámetros
  • announcementIdpathintegerObligatorio
  • deviceIdpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/announcements/{announcementId}/devices/{deviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/announcements/{announcementId}/devices/{deviceId}

Desasignar un dispositivo de un anuncio

Parámetros
  • announcementIdpathintegerObligatorio
  • deviceIdpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/announcements/{announcementId}/devices/{deviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

audience-segment-controller

10 endpoints
post/api/audiences

createSegment

cURL
curl -X POST "https://api.pre.screenleads.com/api/audiences" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/audiences/{id}

getSegmentById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/audiences/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/audiences/{id}

updateSegment_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/audiences/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/audiences/{id}

deleteSegment

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/audiences/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/audiences/preview

previewSegment

cURL
curl -X POST "https://api.pre.screenleads.com/api/audiences/preview" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/audiences/{id}/toggle

toggleSegmentActive

Parámetros
  • idpathintegerObligatorio
  • activequerybooleanObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/audiences/{id}/toggle" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/audiences/{id}/customers

getSegmentCustomers

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/audiences/{id}/customers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/audiences/recalculate-all

recalculateAllSegments

cURL
curl -X POST "https://api.pre.screenleads.com/api/audiences/recalculate-all" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/audiences/{id}/recalculate

recalculateSegmentCount

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/audiences/{id}/recalculate" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/audiences/company/{companyId}

getSegmentsByCompany

Parámetros
  • companyIdpathintegerObligatorio
  • activeOnlyqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/api/audiences/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Customers

17 endpoints

Gestión de clientes finales que canjean promociones

get/api/customers

Listar todos los customers

cURL
curl -X GET "https://api.pre.screenleads.com/api/customers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers

Crear nuevo customer

Público para que dispositivos registren customers al canjear

cURL
curl -X POST "https://api.pre.screenleads.com/api/customers" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/customers/{id}

Obtener customer por ID

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/customers/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/customers/{id}

Actualizar customer existente

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/customers/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/customers/{id}

Eliminar customer

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/customers/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/search

Buscar customers con criterios y paginación

Parámetros
  • pageablequeryObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/search" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/sso-login

Registro/login SSO con Firebase

Permite registrar o loguear un customer usando SSO (Google, Facebook, etc) validando el token de Firebase

cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/sso-login" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/{id}/tags

Añadir tags a customer

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/{id}/tags" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/customers/{id}/stats

Obtener estadísticas de customer

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/customers/{id}/stats" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/customers/{id}/segment

Actualizar segmento de customer

Parámetros
  • idpathintegerObligatorio
  • segmentquerystringObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/customers/{id}/segment" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/customers/email/{email}

Buscar customer por email

Parámetros
  • emailpathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/customers/email/{email}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/customers/phone/{phone}

Buscar customer por teléfono

Parámetros
  • phonepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/customers/phone/{phone}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/{id}/verify-email

Verificar email de customer

Público para que el customer verifique su email

Parámetros
  • idpathintegerObligatorio
  • tokenquerystringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/{id}/verify-email" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/{id}/verify-phone

Verificar teléfono de customer

Público para que el customer verifique su teléfono

Parámetros
  • idpathintegerObligatorio
  • codequerystringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/{id}/verify-phone" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/customers/company/{companyId}

Obtener customers de una compañía

Retorna todos los customers que han canjeado promociones de esta compañía

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/customers/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/{id}/update-lifetime-value

Actualizar lifetime value de customer

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/{id}/update-lifetime-value" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/customers/{id}/recalculate-engagement

Recalcular engagement score de customer

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/customers/{id}/recalculate-engagement" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

notification-template-controller

9 endpoints
post/api/templates

createTemplate

cURL
curl -X POST "https://api.pre.screenleads.com/api/templates" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/templates/{id}

getTemplateById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/templates/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/templates/{id}

updateTemplate

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/templates/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/templates/{id}

deleteTemplate

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/templates/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/templates/preview

previewTemplateContent

cURL
curl -X POST "https://api.pre.screenleads.com/api/templates/preview" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/templates/{id}/toggle

toggleTemplateActive

Parámetros
  • idpathintegerObligatorio
  • activequerybooleanObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/templates/{id}/toggle" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/templates/{id}/preview

previewTemplate

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/templates/{id}/preview" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/templates/company/{companyId}

getTemplatesByCompany

Parámetros
  • companyIdpathintegerObligatorio
  • channelquerystring
  • activeOnlyqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/api/templates/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/templates/company/{companyId}/most-used

getMostUsedTemplates

Parámetros
  • companyIdpathintegerObligatorio
  • limitqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/templates/company/{companyId}/most-used" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Device Types

5 endpoints

CRUD de tipos de dispositivo

get/devices/types

Listar tipos de dispositivo

cURL
curl -X GET "https://api.pre.screenleads.com/devices/types" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/devices/types

Crear tipo de dispositivo

cURL
curl -X POST "https://api.pre.screenleads.com/devices/types" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/devices/types/{id}

Obtener tipo de dispositivo por id

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/devices/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/devices/types/{id}

Actualizar tipo de dispositivo

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/devices/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/devices/types/{id}

Eliminar tipo de dispositivo

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/devices/types/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

company-token-controller

7 endpoints
get/company-tokens

getTokens

cURL
curl -X GET "https://api.pre.screenleads.com/company-tokens" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/company-tokens

createToken

cURL
curl -X POST "https://api.pre.screenleads.com/company-tokens" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/company-tokens/{id}

getTokenById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/company-tokens/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/company-tokens/{id}

updateToken

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/company-tokens/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/company-tokens/{id}

deleteToken

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/company-tokens/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/company-tokens/{token}/renew

renewToken

Parámetros
  • tokenpathstringObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/company-tokens/{token}/renew" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/company-tokens/{token}/description

updateDescription

Parámetros
  • tokenpathstringObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/company-tokens/{token}/description" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

fraud-rule-controller

12 endpoints
post/api/fraud-rules

createRule_2

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud-rules" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/{id}

getRuleById_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/fraud-rules/{id}

updateRule_2

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/fraud-rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/fraud-rules/{id}

deleteRule_2

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/fraud-rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/fraud-rules/{id}/toggle-active

toggleRuleActive_1

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/fraud-rules/{id}/toggle-active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}

getRulesByCompany_1

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/count

countActiveRulesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/count" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/active

getActiveRulesByCompany_1

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/exists

ruleNameExists

Parámetros
  • companyIdpathintegerObligatorio
  • namequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/exists" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/auto-block

getAutoBlockRulesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/auto-block" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/type/{ruleType}

getRulesByType

Parámetros
  • companyIdpathintegerObligatorio
  • ruleTypepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/type/{ruleType}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-rules/company/{companyId}/severity/{severity}

getRulesBySeverity

Parámetros
  • companyIdpathintegerObligatorio
  • severitypathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-rules/company/{companyId}/severity/{severity}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

fraud-detection-controller

16 endpoints
post/api/fraud/check

checkForFraud

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud/check" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/fraud/rules

createRule_1

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud/rules" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/fraud/alerts

createAlert

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud/alerts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/fraud/blacklist

addToBlacklist

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud/blacklist" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/rules/{ruleId}

getRule

Parámetros
  • ruleIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/rules/{ruleId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/fraud/rules/{ruleId}

updateRule_1

Parámetros
  • ruleIdpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/fraud/rules/{ruleId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/fraud/rules/{ruleId}

deleteRule_1

Parámetros
  • ruleIdpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/fraud/rules/{ruleId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/blacklist/check

checkBlacklist

Parámetros
  • companyIdqueryintegerObligatorio
  • typequerystringObligatorio
  • valuequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/blacklist/check" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/alerts/{alertId}

getAlert

Parámetros
  • alertIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/alerts/{alertId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/fraud/alerts/{alertId}/status

updateAlertStatus

Parámetros
  • alertIdpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/fraud/alerts/{alertId}/status" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/fraud/blacklist/{blacklistId}

removeFromBlacklist

Parámetros
  • blacklistIdpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/fraud/blacklist/{blacklistId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/rules/company/{companyId}

getCompanyRules

Parámetros
  • companyIdpathintegerObligatorio
  • activeOnlyqueryboolean
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/rules/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/alerts/company/{companyId}

getCompanyAlerts

Parámetros
  • companyIdpathintegerObligatorio
  • pagequeryinteger
  • sizequeryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/alerts/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/blacklist/company/{companyId}

getCompanyBlacklist

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/blacklist/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/alerts/company/{companyId}/stats

getAlertStats

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/alerts/company/{companyId}/stats" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud/alerts/company/{companyId}/pending

getPendingAlerts

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud/alerts/company/{companyId}/pending" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

user-invitation-controller

6 endpoints
get/api/invitations

getCompanyInvitations

cURL
curl -X GET "https://api.pre.screenleads.com/api/invitations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/invitations

createInvitation

cURL
curl -X POST "https://api.pre.screenleads.com/api/invitations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/invitations/{id}

getInvitation

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/invitations/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/invitations/{id}

cancelInvitation

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/invitations/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/invitations/verify

verifyToken

Parámetros
  • tokenquerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/invitations/verify" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/invitations/{id}/resend

resendInvitation

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/invitations/{id}/resend" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Company Billing

9 endpoints

Gestión de facturación de empresas

get/company-billing

Listar configuraciones de facturación

cURL
curl -X GET "https://api.pre.screenleads.com/company-billing" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/company-billing

Crear configuración de facturación

Solo ROLE_ADMIN

cURL
curl -X POST "https://api.pre.screenleads.com/company-billing" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/company-billing/{id}

Obtener configuración de facturación por ID

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/company-billing/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/company-billing/{id}

Actualizar configuración de facturación

Solo ROLE_ADMIN

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/company-billing/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/company-billing/{id}

Eliminar configuración de facturación

Solo ROLE_ADMIN

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/company-billing/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/company-billing/{id}/reset-period

Resetear periodo actual

Solo ROLE_ADMIN

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/company-billing/{id}/reset-period" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/company-billing/company/{companyId}

Obtener configuración de facturación por empresa

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/company-billing/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/company-billing/{id}/device-limit-reached

Verificar si alcanzó límite de devices

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/company-billing/{id}/device-limit-reached" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/company-billing/{id}/promotion-limit-reached

Verificar si alcanzó límite de promociones

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/company-billing/{id}/promotion-limit-reached" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

fraud-alert-controller

17 endpoints
post/api/fraud-alerts

createAlert_1

cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud-alerts" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/{id}

getAlertById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/fraud-alerts/{id}

updateAlert

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/fraud-alerts/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/fraud-alerts/{id}

deleteAlert

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/fraud-alerts/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/fraud-alerts/{id}/status

updateAlertStatus_1

Parámetros
  • idpathintegerObligatorio
  • statusquerystringObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/fraud-alerts/{id}/status" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/fraud-alerts/{id}/resolve

resolveAlert

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/fraud-alerts/{id}/resolve" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/rule/{ruleId}

getAlertsByRule

Parámetros
  • ruleIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/rule/{ruleId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}

getAlertsByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/recent

getRecentAlertsByCompany

Parámetros
  • companyIdpathintegerObligatorio
  • daysqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/recent" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/pending

getPendingAlertsByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/pending" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/statistics

getAlertStatistics

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/statistics" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/high-priority

getHighPriorityAlertsByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/high-priority" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/status/{status}

getAlertsByStatus

Parámetros
  • companyIdpathintegerObligatorio
  • statuspathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/status/{status}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/severity/{severity}

getAlertsBySeverity

Parámetros
  • companyIdpathintegerObligatorio
  • severitypathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/severity/{severity}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/count/status/{status}

countAlertsByStatus

Parámetros
  • companyIdpathintegerObligatorio
  • statuspathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/count/status/{status}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/count/severity/{severity}

countAlertsBySeverity

Parámetros
  • companyIdpathintegerObligatorio
  • severitypathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/count/severity/{severity}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/fraud-alerts/company/{companyId}/entity/{entityType}/{entityId}

getAlertsByRelatedEntity

Parámetros
  • companyIdpathintegerObligatorio
  • entityTypepathstringObligatorio
  • entityIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/fraud-alerts/company/{companyId}/entity/{entityType}/{entityId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

ws-command-controller

3 endpoints
post/ws/test/{roomId}

test

Parámetros
  • roomIdpathstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/ws/test/{roomId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/ws/command/{roomId}

sendCommand

Parámetros
  • roomIdpathstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/ws/command/{roomId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/ws/test-message/{roomId}

sendMessageTest

Parámetros
  • roomIdpathstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/ws/test-message/{roomId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

geofence-rule-controller

11 endpoints
post/api/geofence/rules

createRule

cURL
curl -X POST "https://api.pre.screenleads.com/api/geofence/rules" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/{id}

getRuleById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/geofence/rules/{id}

updateRule

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/geofence/rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/geofence/rules/{id}

deleteRule

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/geofence/rules/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/geofence/rules/{id}/active

toggleRuleActive

Parámetros
  • idpathintegerObligatorio
  • activequerybooleanObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/geofence/rules/{id}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/zone/{zoneId}

getRulesByZone

Parámetros
  • zoneIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/zone/{zoneId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/company/{companyId}

getRulesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/zone/{zoneId}/active

getActiveRulesByZone

Parámetros
  • zoneIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/zone/{zoneId}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/zone/{zoneId}/applicable

findApplicableRules

Parámetros
  • zoneIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/zone/{zoneId}/applicable" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/company/{companyId}/count

countActiveRules

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/company/{companyId}/count" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/rules/company/{companyId}/active

getActiveRulesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/rules/company/{companyId}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

geofence-zone-controller

9 endpoints
post/api/geofence/zones

createZone

cURL
curl -X POST "https://api.pre.screenleads.com/api/geofence/zones" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/zones/{id}

getZoneById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/zones/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/geofence/zones/{id}

updateZone

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/geofence/zones/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/geofence/zones/{id}

deleteZone

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/geofence/zones/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
patch/api/geofence/zones/{id}/active

toggleZoneActive

Parámetros
  • idpathintegerObligatorio
  • activequerybooleanObligatorio
cURL
curl -X PATCH "https://api.pre.screenleads.com/api/geofence/zones/{id}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/zones/company/{companyId}

getZonesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/zones/company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/zones/company/{companyId}/count

countActiveZones

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/zones/company/{companyId}/count" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/zones/company/{companyId}/point

findZonesContainingPoint

Parámetros
  • companyIdpathintegerObligatorio
  • latitudequerynumberObligatorio
  • longitudequerynumberObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/zones/company/{companyId}/point" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/zones/company/{companyId}/active

getActiveZonesByCompany

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/zones/company/{companyId}/active" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

stripe-webhook-controller

1 endpoint
post/api/stripe/webhook

handle

Parámetros
  • Stripe-SignatureheaderstringObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/stripe/webhook" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

geofence-event-controller

8 endpoints
post/api/geofence/events

recordEvent

cURL
curl -X POST "https://api.pre.screenleads.com/api/geofence/events" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/{id}

getEventById

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/zone/{zoneId}

getEventsByZone

Parámetros
  • zoneIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/zone/{zoneId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/geofence/events/location-update

processLocationUpdate

cURL
curl -X POST "https://api.pre.screenleads.com/api/geofence/events/location-update" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/type/{eventType}

getEventsByTypeAndDateRange

Parámetros
  • eventTypepathstringObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/type/{eventType}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/device/{deviceId}

getEventsByDevice

Parámetros
  • deviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/device/{deviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/zone/{zoneId}/recent

getRecentEventsByZone

Parámetros
  • zoneIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/zone/{zoneId}/recent" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/geofence/events/zone/{zoneId}/count/{eventType}

countEventsByZoneAndType

Parámetros
  • zoneIdpathintegerObligatorio
  • eventTypepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/geofence/events/zone/{zoneId}/count/{eventType}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Promotion Redemptions

10 endpoints

CRUD de canjes de promociones

get/promotion-redemptions

Listar todos los canjes

cURL
curl -X GET "https://api.pre.screenleads.com/promotion-redemptions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/promotion-redemptions

Crear nuevo canje

ROLE_ADMIN o permiso redemption:write

cURL
curl -X POST "https://api.pre.screenleads.com/promotion-redemptions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotion-redemptions/{id}

Obtener canje por ID

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotion-redemptions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/promotion-redemptions/{id}

Actualizar canje

ROLE_ADMIN o permiso redemption:write

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/promotion-redemptions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/promotion-redemptions/{id}

Eliminar canje

ROLE_ADMIN o permiso redemption:delete

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/promotion-redemptions/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/promotion-redemptions/{id}/redeem

Marcar como canjeado

ROLE_ADMIN o permiso redemption:write

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/promotion-redemptions/{id}/redeem" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/promotion-redemptions/{id}/verify

Verificar canje

ROLE_ADMIN o permiso redemption:write

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/promotion-redemptions/{id}/verify" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotion-redemptions/coupon/{couponCode}

Obtener canje por código de cupón

Parámetros
  • couponCodepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotion-redemptions/coupon/{couponCode}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotion-redemptions/customer/{customerId}

Listar canjes por cliente

Parámetros
  • customerIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotion-redemptions/customer/{customerId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/promotion-redemptions/promotion/{promotionId}

Listar canjes por promoción

Parámetros
  • promotionIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/promotion-redemptions/promotion/{promotionId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

marketing-campaign-controller

13 endpoints
get/api/marketing-campaigns

getCampaignsByCompany

Parámetros
  • companyIdqueryintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/marketing-campaigns" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns

createCampaign

Parámetros
  • companyIdqueryintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/marketing-campaigns/top

getTopCampaigns

Parámetros
  • companyIdqueryintegerObligatorio
  • limitqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/marketing-campaigns/top" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/marketing-campaigns/{id}

getCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/marketing-campaigns/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/marketing-campaigns/{id}

updateCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X PUT "https://api.pre.screenleads.com/api/marketing-campaigns/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/marketing-campaigns/{id}

deleteCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X DELETE "https://api.pre.screenleads.com/api/marketing-campaigns/{id}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns/{id}/pause

pauseCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/pause" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns/{id}/cancel

cancelCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/cancel" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns/{id}/resume

resumeCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/resume" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns/{id}/execute

executeCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/execute" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/marketing-campaigns/{id}/schedule

scheduleCampaign

Parámetros
  • idpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/schedule" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/marketing-campaigns/status/{status}

getCampaignsByStatus

Parámetros
  • statuspathstringObligatorio
  • companyIdqueryintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/marketing-campaigns/status/{status}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/marketing-campaigns/{id}/statistics

getCampaignStatistics

Parámetros
  • idpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/marketing-campaigns/{id}/statistics" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

advice-impression-controller

6 endpoints
post/api/analytics/impressions

trackImpression

cURL
curl -X POST "https://api.pre.screenleads.com/api/analytics/impressions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/impressions/advice/{adviceId}

getImpressionsByAdvice

Parámetros
  • adviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/impressions/advice/{adviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/impressions/device/{deviceId}

getImpressionsByDevice

Parámetros
  • deviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/impressions/device/{deviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/impressions/session/{sessionId}

getImpressionsBySession

Parámetros
  • sessionIdpathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/impressions/session/{sessionId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/impressions/customer/{customerId}

getImpressionsByCustomer

Parámetros
  • customerIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/impressions/customer/{customerId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/impressions/advice/{adviceId}/stats

getImpressionStats

Parámetros
  • adviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/impressions/advice/{adviceId}/stats" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

api-key-permission-test-controller

8 endpoints
get/api/test-permissions/info

getApiKeyInfo

cURL
curl -X GET "https://api.pre.screenleads.com/api/test-permissions/info" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
delete/api/test-permissions/lead/delete

testLeadDelete

cURL
curl -X DELETE "https://api.pre.screenleads.com/api/test-permissions/lead/delete" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
put/api/test-permissions/lead/update

testLeadUpdate

cURL
curl -X PUT "https://api.pre.screenleads.com/api/test-permissions/lead/update" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/test-permissions/snapshot/read

testSnapshotRead

cURL
curl -X GET "https://api.pre.screenleads.com/api/test-permissions/snapshot/read" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/test-permissions/check-multiple

checkMultiplePermissions

Parámetros
  • resourcequerystring
  • actionquerystring
cURL
curl -X GET "https://api.pre.screenleads.com/api/test-permissions/check-multiple" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/test-permissions/snapshot/create

testSnapshotCreate

cURL
curl -X POST "https://api.pre.screenleads.com/api/test-permissions/snapshot/create" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/test-permissions/global-access-required

testGlobalAccess

cURL
curl -X GET "https://api.pre.screenleads.com/api/test-permissions/global-access-required" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/test-permissions/can-access-company/{companyId}

testCompanyAccess

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/test-permissions/can-access-company/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

advice-interaction-controller

6 endpoints
post/api/analytics/interactions

trackInteraction

cURL
curl -X POST "https://api.pre.screenleads.com/api/analytics/interactions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/interactions/type/{type}

getInteractionsByType

Parámetros
  • typepathstringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/interactions/type/{type}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/interactions/advice/{adviceId}

getInteractionsByAdvice

Parámetros
  • adviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/interactions/advice/{adviceId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/interactions/customer/{customerId}

getInteractionsByCustomer

Parámetros
  • customerIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/interactions/customer/{customerId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/interactions/advice/{adviceId}/stats

getInteractionStats

Parámetros
  • adviceIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/interactions/advice/{adviceId}/stats" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/interactions/impression/{impressionId}

getInteractionsByImpression

Parámetros
  • impressionIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/interactions/impression/{impressionId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

analytics-dashboard-controller

9 endpoints
get/api/analytics/dashboard/roi

getPromotionROI

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/roi" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/summary

getDashboardSummary

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/summary" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/overview

getDashboardOverview

Parámetros
  • companyIdqueryinteger
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/overview" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/daily-trends

getDailyTrends

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/daily-trends" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/device-performance

getDevicePerformance

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/device-performance" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/geographic-metrics

getGeographicMetrics

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/geographic-metrics" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/hourly-distribution

getHourlyDistribution

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/hourly-distribution" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/top-promotions/revenue

getTopPromotionsByRevenue

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • limitqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/top-promotions/revenue" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/dashboard/top-promotions/conversion

getTopPromotionsByConversion

Parámetros
  • companyIdqueryintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • limitqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/dashboard/top-promotions/conversion" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

billing-controller

2 endpoints
post/api/billing/portal-session/{companyId}

portal

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/billing/portal-session/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
post/api/billing/checkout-session/{companyId}

createCheckout

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X POST "https://api.pre.screenleads.com/api/billing/checkout-session/{companyId}" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

advanced-analytics-controller

10 endpoints
get/api/analytics/advanced/company/{companyId}/clv

getCustomerLifetimeValue

Parámetros
  • companyIdpathintegerObligatorio
  • customerIdqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/clv" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/cohort

getCohortAnalysis

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • periodDaysqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/cohort" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/export

exportAnalytics

Parámetros
  • companyIdpathintegerObligatorio
  • reportTypequerystringObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/export" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/funnel

getFunnelAnalysis

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/funnel" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/realtime

getRealTimeDashboard

Parámetros
  • companyIdpathintegerObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/realtime" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/attribution

getAttributionAnalysis

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • modelquerystring
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/attribution" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/time-series

getTimeSeriesData

Parámetros
  • companyIdpathintegerObligatorio
  • metricquerystringObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • granularityquerystring
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/time-series" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/conversion-paths

getConversionPaths

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
  • maxPathLengthqueryinteger
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/conversion-paths" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/device-performance

getDevicePerformance_1

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/device-performance" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
get/api/analytics/advanced/company/{companyId}/promotion-comparison

getPromotionComparison

Parámetros
  • companyIdpathintegerObligatorio
  • startDatequerystringObligatorio
  • endDatequerystringObligatorio
cURL
curl -X GET "https://api.pre.screenleads.com/api/analytics/advanced/company/{companyId}/promotion-comparison" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"
322 rutas documentadas en 39 categorías
Preguntas frecuentes

Lo que nos preguntan sobre la API y el MCP

Consultar y gestionar empresas, pantallas, anuncios, promociones, medios, planes, créditos y facturas, siempre con los permisos de tu credencial. Es una API REST normal: una petición HTTP con dos cabeceras (tu API key y tu identificador de cliente) y respuesta en JSON. Lo habitual es usarla para que cada canje llegue a tu CRM o a tu TPV, para crear promociones desde tu propio sistema o para cambiar el anuncio de muchas pantallas a la vez sin pasar por el panel.
Desde ScreenLeads creas un cliente API, que representa tu integración, y le generas una API key con los permisos que quieras: solo lectura o también escritura, y acotada a una empresa si gestionas varias. Te quedas con dos datos, la clave y el identificador de cliente, y los envías en cada petición; no hace falta iniciar sesión cada vez. La clave se revoca o se rota desde el backend sin caídas ni cerrar sesiones. No la pegues en chats, documentos compartidos ni capturas de pantalla.
MCP es el estándar con el que los asistentes de IA (Claude, ChatGPT, Cursor y otros) se conectan a herramientas externas. ScreenLeads tiene su propio servidor MCP: añades la URL del conector a tu asistente, le das tu API key y desde ese momento puedes pedirle en lenguaje natural que consulte tus pantallas, cree una promoción o cambie un anuncio. Tu asistente solo ve y hace lo que tu API key permite: el servidor reenvía tu credencial a la API y no guarda claves propias.
No. Cualquier escritura va en dos pasos: el asistente te enseña una previsualización de lo que va a hacer (qué anuncio, qué pantalla, qué promoción) y solo lo ejecuta cuando confirmas explícitamente. Las consultas, en cambio, son directas. Si le das una API key de solo lectura, solo podrá consultar. Y las respuestas del MCP redactan tokens, contraseñas y secretos para que nunca acaben en la conversación.
Sí. Configuras una URL y ScreenLeads le avisa cada vez que un cliente canjea una promoción, con los datos que dejó, la pantalla y la oferta. Es la forma más sencilla de que cada captura llegue a tu CRM, a tu herramienta de email o WhatsApp, o a un conector tipo Make, Zapier o n8n sin programar nada más. Cada aviso cuesta 1 crédito.
Sí. Los datos de conexión de esta página son los del entorno de preproducción: ahí validas tu integración, pruebas el conector con tu asistente y compruebas los permisos de tu API key sin tocar nada real. La forma de trabajar es la misma. Si tienes dudas en el paso a producción, escríbenos por el chat y lo hacemos contigo.
Lo que gasta créditos es lo que pasa en tus pantallas, no por dónde lo pidas: una promoción creada desde tu asistente cuesta lo mismo que creada desde el panel, un aviso por webhook 1 crédito, una imagen generada con IA 2 y un vídeo de 8 segundos 20. No hay una cuota aparte por integrar: la API y el MCP van incluidos en todos los planes.