Documentación API - Netwash 2.0

API para la gestión y control de centros de lavado de vehículos con integración IoT.


Índice

Información General

La API de Netwash 2.0 permite la integración y gestión de máquinas de lavado de vehículos mediante sistemas IoT (Internet of Things). Con esta API, los integradores y propietarios de centros de lavado podrán realizar las siguientes acciones:

Base URL: https://netwash.app:1880/api/2.0

Volver al índice

Métodos de la API

GET /device
Descripción:

Obtiene la información de la máquina conectada al dispositivo.

Parámetros de consulta:
  • apikey (string, requerido) - Llave de uso API.
  • key (string, requerido) - Llave del dispositivo conectado.
Ejemplo de respuesta:
{
    "name": "Puente de lavado",
    "basecoin": 0,
    "resources": [
        "Foamsensation",
        "Espuma de prelavado químico lateral",
        "Alta presión de techo"
    ],
    "programs": [
        {
            "id": "1",
            "title": "High premium",
            "resources": [true, true, true, true]
        }
    ]
}
Volver al índice
GET /device/state
Descripción:

Consulta el estado actual de la máquina conectada.

Parámetros de consulta:
  • apikey (string, requerido) - Llave de uso API.
  • key (string, requerido) - Llave del dispositivo conectado.
Ejemplo de respuesta:
{
    "state": {
        "code": 4001,
        "info": "Working"
    }
}
Volver al índice
GET /device/active
Descripción:

Activa de forma remota la máquina seleccionada.

Parámetros de consulta:
  • apikey (string, requerido) - Llave de uso API.
  • key (string, requerido) - Llave del dispositivo conectado.
  • id (string, opcional) - Identificador de libre uso.
  • program (string, requerido) - Identificador del programa que se desea activar.
Ejemplo de respuesta:
{
    "id": "identificador1",
    "anotherid": "identificador2",
    "delivered": true
}
Volver al índice

Códigos de Estado

Código Descripción
1001 Out of service
1002 Out of service for remote operations
2001 Standby
3001 Ready
4001 Working
Volver al índice

Códigos de Error

Código Descripción
1001 Missing device key
1002 Device key not found
1003 Required parameters are missing
1004 Missing API key
1006 The API key is not valid for the device
3001 No configuration for the device
Volver al índice