Documentación API

Integra NodeCoreX con APIs locales (puerto 5200) y APIs remotas. Las solicitudes remotas requieren firma SHA-256 de cuenta, contraseña, código de máquina y marca de tiempo.

API local del dispositivo

URL base: http://localhost:5200

GET http://localhost:5200/nodes/count

Obtener el recuento de nodos

Obtenga la cantidad total de nodos publicitarios que se ejecutan en el dispositivo actual.

Éxito (HTTP 200):

{
  "success": true,
  "count": 4
}

Error (no 200):

{
  "success": false,
  "message": "Service unavailable"
}

GET http://localhost:5200/nodes/list

Obtener lista de índice de nodos

Obtenga la lista de todos los índices de nodos para operaciones posteriores por índice.

Éxito (HTTP 200):

{
  "success": true,
  "nodeIndexes": [
    0,
    1,
    2,
    3
  ]
}

Error (no 200):

{
  "success": false,
  "message": "Failed to list nodes"
}

GET http://localhost:5200/nodes/status

Obtener el estado del nodo

Obtenga el estado de ejecución de cada nodo (en ejecución, detenido, error, etc.).

Éxito (HTTP 200):

{
  "success": true,
  "statuses": [
    {
      "index": 0,
      "status": "running",
      "uptime": 3600
    },
    {
      "index": 1,
      "status": "stopped",
      "uptime": 0
    },
    {
      "index": 2,
      "status": "error",
      "message": "Proxy timeout"
    }
  ]
}

Error (no 200):

{
  "success": false,
  "message": "Unable to read node status"
}

POST http://localhost:5200/nodes/{nodeIndex}/start

Iniciar un nodo

Inicie el nodo de reproducción de anuncios para el índice de nodo determinado.

Parámetros:

nodeIndex (path) — Índice de nodo (basado en 0)

Éxito (HTTP 200):

{
  "success": true,
  "message": "Node started",
  "index": 0
}

Error (no 200):

{
  "success": false,
  "message": "Invalid node index or already running"
}

POST http://localhost:5200/nodes/{nodeIndex}/stop

Detener un nodo

Detenga el nodo de reproducción de anuncios para el índice de nodo determinado.

Parámetros:

nodeIndex (path) — Índice de nodo (basado en 0)

Éxito (HTTP 200):

{
  "success": true,
  "message": "Node stopped",
  "index": 0
}

Error (no 200):

{
  "success": false,
  "message": "Invalid node index or already stopped"
}

POST http://localhost:5200/nodes/{nodeIndex}/proxy

Establecer proxy para un nodo

Configure la conexión proxy (host, puerto, autenticación, etc.) para el índice de nodo determinado.

Parámetros:

nodeIndex (path) — índice de nodo
ip (body) — Punto final de proxy
port (body) — Puerto proxy
username (body) — Nombre de usuario proxy (opcional)
password (body) — Contraseña de proxy (opcional)

Ejemplo de cuerpo de solicitud:

{
  "ip": "127.0.0.1",
  "port": 7890,
  "username": null,
  "password": null
}

Éxito (HTTP 200):

{
  "success": true,
  "message": "Proxy updated",
  "index": 0
}

Error (no 200):

{
  "success": false,
  "message": "Invalid proxy or connection failed"
}

GET http://localhost:5200/device/info

Obtener información del dispositivo

Obtenga información básica del dispositivo, como código de máquina, modelo y versión.

Éxito (HTTP 200):

{
  "success": true,
  "machineCode": "PM-XXXX-YYYY",
  "model": "Standard",
  "version": "1.0.0",
  "firmware": "1.2.3"
}

Error (no 200):

{
  "success": false,
  "message": "Node info unavailable"
}

GET http://localhost:5200/device/health

Comprobación del estado del dispositivo

Compruebe si el servicio local se está ejecutando; se puede utilizar para informes de latidos del corazón.

Éxito (HTTP 200):

{
  "success": true,
  "healthy": true,
  "uptime": 3600,
  "nodesActive": 4
}

Error (no 200):

{
  "success": false,
  "healthy": false,
  "message": "Service unhealthy"
}

API remota del servidor

URL base: el host de la API de tu plataforma (consulta la consola de la app para endpoints específicos del entorno).

GET /api/device/ads

Obtener lista de tareas publicitarias

Obtenga sitios de origen de anuncios, tipos de anuncios, ID de anuncios, URL de reproducción y contenido relacionado.

Parámetros:

sign (query) requerido — Firma; consulte el algoritmo de signos a continuación
machineCode (query) requerido — Código de dispositivo de hardware
timestamp (query) requerido — Solicitar marca de tiempo (segundos)

Éxito (HTTP 200):

{
  "success": true,
  "data": {
    "ads": [
      {
        "id": "ad-001",
        "adType": "Video",
        "source": "example.com",
        "sourceUrl": "https://example.com/campaign/1",
        "playUrl": "https://cdn.example.com/ad-001",
        "duration": 30,
        "rewardPerView": 0.001
      }
    ]
  }
}

Error (no 200):

{
  "success": false,
  "message": "Invalid sign or expired timestamp",
  "code": "AUTH_FAILED"
}

GET /api/device/earnings

Obtenga ganancias por nodo o dispositivo

Obtenga detalles de ganancias o resumen por código de dispositivo e índice de nodo opcional.

Parámetros:

sign (query) requerido — Firma
machineCode (query) requerido — Código del dispositivo
timestamp (query) requerido — Marca de tiempo
nodeIndex (query) — Índice de nodo; omitir para obtener ganancias en todo el dispositivo
startDate (query) — Fecha de inicio AAAA-MM-DD
endDate (query) — Fecha de finalización AAAA-MM-DD

Éxito (HTTP 200):

{
  "success": true,
  "data": {
    "totalPoints": 1200,
    "currency": "points",
    "details": [
      {
        "date": "2025-03-01",
        "nodeIndex": 0,
        "points": 300,
        "adCount": 120
      },
      {
        "date": "2025-03-01",
        "nodeIndex": 1,
        "points": 280,
        "adCount": 115
      }
    ]
  }
}

Error (no 200):

{
  "success": false,
  "message": "Node not found or access denied",
  "code": "FORBIDDEN"
}

POST /api/device/heartbeat

Latido del dispositivo

Informe periódicamente el estado en línea del dispositivo y el estado de ejecución del nodo.

Parámetros:

sign (query) requerido — Firma
machineCode (query) requerido — Código del dispositivo
timestamp (query) requerido — Marca de tiempo

Ejemplo de cuerpo de solicitud:

{
  "nodeStatuses": [
    {
      "index": 0,
      "status": "running",
      "uptime": 3600
    },
    {
      "index": 1,
      "status": "running",
      "uptime": 3600
    },
    {
      "index": 2,
      "status": "stopped",
      "uptime": 0
    }
  ],
  "deviceHealthy": true
}

Éxito (HTTP 200):

{
  "success": true,
  "message": "Heartbeat received",
  "nextReportIn": 60
}

Error (no 200):

{
  "success": false,
  "message": "Invalid sign or machineCode",
  "code": "AUTH_FAILED"
}

GET /api/device/config

Obtener configuración del dispositivo

Obtenga la configuración de ejecución para el dispositivo (por ejemplo, intervalo de tarea, límites de región).

Parámetros:

sign (query) requerido — Firma
machineCode (query) requerido — Código del dispositivo
timestamp (query) requerido — Marca de tiempo

Éxito (HTTP 200):

{
  "success": true,
  "data": {
    "taskInterval": 30,
    "allowedRegions": [
      "US",
      "GB",
      "DE"
    ],
    "maxConcurrentAds": 4,
    "reportInterval": 60
  }
}

Error (no 200):

{
  "success": false,
  "message": "Invalid sign or node",
  "code": "AUTH_FAILED"
}

Algoritmo de signos

Las solicitudes a la API remota requieren parámetros de consulta sign, machineCode, y timestamp.

sign = SHA256(account + password + machineCode + timestamp)

Crear una cuenta Centro de ayuda