NSnappy 3rd party REST API

1. Yleiskuvaus

NSnappy tarjoaa asiakkailleen kolmannen osapuolen REST-rajapinnan (API), jonka avulla integraatiot voidaan toteuttaa järjestelmätasolla. Tällä hetkellä rajapinnan kautta voidaan hakea tietoa NSnappyyn liitetyistä mittalaitteista ja yhdyskäytävistä. Rajapintaan voidaan lisätä uusia ominaisuuksia tulevaisuudessa.

Pyydä tarjousta kolmannen osapuolen REST-rajapinnan käytöstä NSnappy-yhteyshenkilöltäsi.

2. Aloittaminen

1. Luo uusi käyttäjätili REST-rajapinnan käyttöä varten

2. Määritä API-käyttäjälle tarvittavat käyttöoikeudet

3. Pyydä Nokevalia luomaan API-avain kyseiselle käyttäjälle

4. Nokeval toimittaa API-avaimen turvallisesti

5. Tutustu API-dokumentaatioon

6. Suunnittele, toteuta ja testaa integraatio

3. API-dokumentaatio

Pyydä NSnappy-yhteyshenkilöäsi lähettämään API-dokumentaatiopaketti ZIP-tiedostona. Saatuasi paketin pura se tietokoneellesi kansioon. Avaa puretun kansion index.html-tiedosto selaimessasi lukeaksesi dokumentaation.

4. API:n käyttö

API:n käyttöä rajoittaa käyttäjäkohtainen käyttöpaketti. Oletuskäyttöpaketti sisältää seuraavat rajoitukset:

• Throttle (kyselynopeus): 10 kyselyä sekunnissa

• Burst (piikkikuormitus): 2 kyselyä

Lisäksi API-vastauksen enimmäiskoko on rajoitettu 10 megatavuun (10 MB).

Vastauskoon rajoitus tulee huomioida API-kyselystrategiaa suunniteltaessa. Integraatiota ja kyselyitä suunniteltaessa on myös huomioitava, että vastaukset ovat JSON-muodossa. Esimerkki API:n JSON-vastauksesta:

{"value":-1.79,"measured_at":"2026-03-12T07:31:38.000Z"},