Einführung

In dieser Dokumentation finden Sie alles, was Sie für die Nutzung unserer API und die Erfassung der Daten Ihrer Geräte benötigen.

				
					Basis-URL: api.gsmcloud.com

Authentifizierungsanfragen

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.

Alle authentifizierten Endpunkte sind in der nachstehenden Dokumentation mit dem Symbol "Authentifizierung erforderlich" gekennzeichnet.

Beispiel: Beispiel

				
					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());

Geräte

Alle Geräte auflisten

ERFORDERT AUTHENTIFIZIERUNG

GET / GERÄTE

Überschriften:

				
					Autorisierung:
Beispiel: Basic {YOUR_AUTH_KEY}

Content-Type:
Beispiel: application/json

Akzeptieren:
Beispiel: application/json

Antwort:

				
					id: Integer
Gerät

name: Zeichenkette
Gegebener Name für das Gerät.

imei: Zeichenkette
IMEI-Nummer des Geräts.

last_package_at: string
Letzter Zeitpunkt, zu dem das Gerät als online registriert wurde.

ports: Objekt
  name - Name des Anschlusses.
  label - alternativer Name, der bei der Erstellung des Anschlusses vergeben wurde.
  Richtung - Eingang/Ausgang.
  value - aktueller Wert des Ports.
  Typ - Datentyp

Beispiel:

				
					[
    {
        "id": 1,
        "name": "Log test",
        "imei": "868333033900099",
        "last_package_at": "2023-07-10T22:44:04.000000Z",
        "ports": {
            "power": {
                "name": "Leistung",
                "Bezeichnung": null,
                "direction": "input",
                "value": true,
                "type": "boolean"
            },
            "IN 1": {
                "name": "IN 1",
                "Bezeichnung": null,
                "Richtung": "input",
                "Wert": 300,
                "type": "temperature"
            },
            "IN 2": {
                "name": "IN 2",
                "Bezeichnung": null,
                "Richtung": "Eingang",
                "Wert": 160,
                "type": "analog"
            },
            "IN 3": {
                "name": "IN 3",
                "Bezeichnung": null,
                "Richtung": "Eingang",
                "Wert": wahr,
                "type": "boolean"
            },
            "Signal": {
                "name": "Signal",
                "Bezeichnung": null,
                "Richtung": "Eingabe",
                "Wert": 15,
                "type": "integer"
            },
            "Relais": {
                "name": "Relais",
                "Bezeichnung": null,
                "Richtung": "Ausgang",
                "Wert": null,
                "type": "boolean"
            },
            "Intervall": {
                "name": "Intervall",
                "Bezeichnung": null,
                "Richtung": "Ausgabe",
                "Wert": null,
                "type": "integer"
            },
            "status": {
                "name": "status",
                "Bezeichnung": null,
                "direction": "input",
                "value": true,
                "type": "boolean"
            }
        }
    }
]

Ein Gerät aktualisieren

Alle Geräte auflisten

ERFORDERT AUTHENTIFIZIERUNG

PATCH / GERÄTE

Überschriften:

				
					Autorisierung:
Beispiel: Basic {YOUR_AUTH_KEY}

Content-Type:
Beispiel: application/json

Akzeptieren:
Beispiel: application/json

Antwort:

				
					URL-Parameter:
Die ID des Geräts

Körper-Parameter:
Name: Name (optional)
Name des Geräts.

Beispiel für eine Anfrage:

				
					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());

Antwort-Codes

200

Reaktion auf den Erfolg

401

Nicht auktorisiert

422

Validierungsfehler

Nodes