Introducción

Esta documentación le proporcionará todo lo necesario para utilizar nuestra API y recopilar los datos de sus unidades.

				
					URL base: api.gsmcloud.com

Solicitudes de autenticación

To authenticate requests, include an Authorization header in the form “Basic {credentials}”. The value of {credentials} should be your username/id and your password, joined with a colon (:), and then base64-encoded.

Todos los puntos finales autenticados están marcados con una insignia de autenticación requerida en la siguiente documentación.

Ejemplo

				
					const url = new URL(
    "api.gsmcloud.dk/devices"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Dispositivos

Lista de dispositivos

REQUIERE AUTENTICACIÓN

GET / DISPOSITIVOS

Cabeceras:

				
					Autorización:
Ejemplo: Básica {YOUR_AUTH_KEY}

Content-Type:
Ejemplo: application/json

Accept:
Ejemplo: application/json

Respuesta:

				
					id: Entero
Dispositivo

nombre: cadena
Nombre dado para el dispositivo.

imei: cadena
Número IMEI del dispositivo.

last_package_at: cadena
Última vez que el dispositivo se registró como conectado.

ports: objeto
  name - nombre del puerto.
  label - nombre alternativo dado al crear el puerto.
  dirección - entrada/salida.
  value - valor actual del puerto.
  type - tipo de datos .

Ejemplo:

				
					[
    {
        "id": 1
        "name": "Log test",
        "imei": "868333033900099",
        "last_package_at": "2023-07-10T22:44:04.000000Z",
        "puertos": {
            "potencia": {
                "name": "Power",
                "label": null
                "dirección": "entrada",
                "value": "true",
                "type": "boolean"
            },
            "IN 1": {
                "name": "IN 1",
                "label": null
                "direction": "input",
                "value": 300
                "type": "temperature"
            },
            "ENTRADA 2": {
                "name": "IN 2",
                "label": "null",
                "dirección": "entrada",
                "value": 160
                "type": "analogue"
            },
            "ENTRADA 3": {
                "name": "IN 3",
                "label": "null",
                "direction": "input",
                "value": "true",
                "type": "boolean"
            },
            "Señal": {
                "name": "Señal",
                "label": null
                "direction": "input",
                "value": 15
                "type": "integer"
            },
            "Relé": {
                "name": "Relé",
                "label": "null",
                "dirección": "salida",
                "value": null
                "type": "boolean"
            },
            "intervalo": {
                "name": "Intervalo",
                "label": null
                "direction": "output",
                "value": null
                "type": "integer"
            },
            "estado": {
                "name": "status",
                "label": null
                "direction": "input",
                "value": "true",
                "type": "boolean"
            }
        }
    }

Actualizar un dispositivo

Lista de dispositivos

REQUIERE AUTENTICACIÓN

PATCH / DISPOSITIVOS

Cabeceras:

				
					Autorización:
Ejemplo: Básica {YOUR_AUTH_KEY}

Content-Type:
Ejemplo: application/json

Accept:
Ejemplo: application/json

Respuesta:

				
					Parámetros URL:
El ID del dispositivo

Parámetros del cuerpo:
Nombre: Nombre (opcional).
Nombre del dispositivo.

Ejemplo de solicitud:

				
					const url = new URL(
    "api.gsmcloud.dk/devices/7"
);

const headers = {
    "Authorization": "Basic {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ex"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Códigos de respuesta

200

Respuesta satisfactoria

401

No autorizado

422

Error de validación

Nodes