Ratar API

Ratar er með API til að nálgast öll helstu gögn frá kerfinu. Nánari upplýsingar er hægt að finna í API Reference

Auðkenning

Það eru nokkrir möguleikar til að auðkenna sig:

  • Með því að nota vafraköku session (sjá session endapunkt hér að neðan)
  • Standard HTTP authorization header
  • Bearer token authentication

Skjölun fyrir Ratar API:

Access token

Einn valmöguleikinn er að nota account token fyrir auðkenningu. Hægt er að búa til API lykil í vefviðmóti Ratar eða með eða með API kalli.

Til að búa til session token þá notaru token í API kallinu:

/api/session?token=USER_TOKEN

WebSocket API

Auk REST API veitum við aðgang að WebSocket endapunkti fyrir live gögn. Endapunktur fyrir WebSocket tenginguna:

/api/socket

Til að auðkenna sig fyrir WebScoket tenginguna er bara hægt að nota Session cookie. Skilaboðin sem koma í WebSocket nota JSON sniðið:

{
    "devices": [...],
    "positions": [...],
    "events": [...]
}