Saltar al contenido principal

Inicio rápido

Esta página te guía desde cero hasta completar un inicio de sesión y llamar a tu primera API.

Requisitos previos​

  • El dispositivo está encendido y conectado a tu red
  • Conoces la dirección IP del dispositivo (en esta guía se usa 192.168.7.200 como ejemplo)
  • Conoces el nombre de usuario y la contraseña de inicio de sesión (el nombre de usuario predeterminado es admin)

Paso 1: Verificar la accesibilidad del dispositivo​

Abre esta URL en un navegador web:

https://192.168.7.200

Si el dispositivo tiene HTTPS habilitado con un certificado autofirmado, el navegador advertirá que el certificado no es de confianza. Para pruebas locales, puedes continuar ignorando la advertencia.

Paso 2: Iniciar sesión para obtener un Token​

El endpoint de inicio de sesión no requiere autenticación. Envía una solicitud de inicio de sesión al dispositivo:

POST https://192.168.7.200/cgi-bin/entry.cgi/system/login
Content-Type: application/json

Cuerpo de la solicitud:

{
  "sUserName": "admin",
  "sPassword": "your_password"
}
nota

La contraseña de inicio de sesión se transmite en texto plano. Si HTTPS está habilitado, la contraseña está protegida por TLS durante la transmisión.

Si tiene éxito, la respuesta es:

{
  "iStatus": 0,
  "iAuth": 1,
  "sWaittime": 0
}
CampoDescripción
iStatus0 = contraseña correcta, -1 = contraseña incorrecta, -3 = bloqueo temporal tras fallos repetidos
iAuth1 = inicio de sesión correcto, 0 = inicio de sesión fallido, 2 = se requiere cambio de contraseña
sWaittimeTiempo de espera en segundos cuando está bloqueado

Las cabeceras de la respuesta también contendrán:

Set-Cookie: token=<JWT_TOKEN>; Max-Age=86400; Path=/

Este token es la credencial de autenticación para todas las solicitudes posteriores a la API.

Paso 3: Llamar a una API con el Token​

Obtener información del dispositivo:

GET https://192.168.7.200/cgi-bin/entry.cgi/system/device-info
Cookie: token=<JWT_TOKEN>

Respuesta:

{
  "sSerialNumber": "RC1126B-20240101-001",
  "sFirmwareVersion": "V1.0.10",
  "sSensorModel": "SC850SL",
  "sBasePlateModel": "Base Board-V1.0,Expand Board-V1.0"
}

Si la solicitud no lleva un Token o el Token ha caducado, el dispositivo devuelve:

{
  "code": 401,
  "message": "Unauthorized: Invalid token or NO token provided"
}

Duración de vida del Token​

El Token es válido durante 24 horas de forma predeterminada (Max-Age=86400). Después de que caduque, inicia sesión de nuevo para obtener un nuevo Token.

Próximos pasos​

  • Consulta Authentication para la referencia completa de inicio de sesión y cambio de contraseña
  • Consulta Common Conventions para los formatos de respuesta y las reglas de nomenclatura de campos
  • Consulta API Reference para las descripciones de endpoints organizadas por función

Soporte técnico y debate sobre el producto​

¡Gracias por elegir nuestros productos! Estamos aquí para ofrecerte diversos tipos de soporte y garantizar que tu experiencia con nuestros productos sea lo más fluida posible. Ofrecemos múltiples canales de comunicación para adaptarnos a diferentes preferencias y necesidades.

Loading Comments...