Denne post er en støtteartikel til serien om en Gør-det-selv dims der kan kontrollere elektriske apparater via internettet.

API Beskrivelse

Adgangen er begrænset med standard HTTP Digest

The credentials are:
Username: XXX
Password: XXX

Strukturen af et API kald:
https://domæne.dk/control.php?action=<ACTION>&device=<DEVICE>

Hvor ACTION kan antage følgende værdier (case sensitive!):
ON : Tænd for udtaget
OFF : Sluk udtaget
STATUS : Returner om udtaget er tændt eller slukket

Og DEVICE er det udtag som der spørges til. To udtag er understøtter, og derfor kan DEVICE antage værdierne 1 og 2.

Eksempler:

Tænd det første udtag::

https://domæne.dk/control.php?action=ON&device=1
Retur værdi:
DEVICE_1_ON

Sluk det første udtag:

https://domæne.dk/control.php?action=OFF&device=1
Retur værdi:
DEVICE_1_OFF

Spørg om status for det første udtag:
https://domæne.dk/control.php?action=OFF&device=1
Retur værdi:

DEVICE_1_ON eller DEVICE_1_OFF

Error messages:

API_ERROR
Forkert værdi givet til ‘action ‘ eller ‘device’. F.eks. “action=status” vil returnere API_ERROR, hvor “action=STATUS” er korrekt.

WRONG_CREDENTIALS
Forkert brugernavn eller password,

UNAUTHORIZED
Digest information mangler i requestet til API

SYSTEM_ERROR
API kald var korrekt, men et eller andet sprang i luften inde i dimsen.

INVALID_DEVICE
Forkert device. Kun device=1 eller 2 er understøttet