Öppna API:er
Åtkomst
Samtliga webbmetoder kräver en säkerhetstoken som ska skickas som parameter till varje anrop. Det finns två typer av säkerhetstokens som är beskrivna i nedan tabell. De allra flesta webbmetoder accepterar en så kallad ”publik ticket” varför de flesta klienter inte behöver anropa SecureTokenService.
| Typ av token | Beskrivning | Hur får jag denna token? |
|---|---|---|
| Publik ticket | En statisk access token som kan tilldelas flera användare och sällan ändras. | Skapa ett konto i Artdatabankens
UserAdmin
.
Logga in i Miljödata MVM. Navigera till sidan "Mina sidor"
och anmäl dig som web service användare. Då får du denna säkerhetstoken. Inget godkännande krävs. |
| Dynamisk, privat token | En privat token som tilldelas inloggade användare. | Skapa ett konto i Artdatabankens
UserAdmin
.
Beställ rollen Tjänstekonsument. Rollen måste godkännas.
Logga in i Miljödata MVM och navigera till sidan "Mina sidor" där aktivering av privat token görs på samma sätt som den publika. |
Version 2
Version 2 är vårt nyare API baserat på OpenAPI Specification 3. Det är en REST tjänst och data returneras som JSON. Det har förbättrad urvalsmöjlighet, uppgraderad respons och stora anrop med förgenererade uttag. Se https://miljodata.slu.se/api/docs/index.html.
| Resurs | Beskrivning |
|---|---|
| AllFullSamples | Förgenererade utsökningar som möjliggör hämtning av alla prover inklusive observationer och mätvärden uppdelat på kemi och biologi. Observera att detta ger mycket stora filer! Överföring och lagring behöver kunna hantera stora datamängder. |
| Common | En uppsättning med anrop för olika systemvärden. |
| FullSamples | Hämtar prover inklusive alla observationer och mätvärden. Urval på provId eller genom filtrering på parametrar. Observera att uttag kan bli stora och ta tid att skapas och laddas ned. Se Swagger-dokumentationen för begränsningar i uttagsstorlek. |
| SamplesIds | Hämtar en lista med provIDn. Filtrering på urvalsparametrar. |
| Samples | Hämtar prover utan enskilda observationer eller värden. För biologiprover hämtas i förekommande fall biologiska index. Urval på provId eller genom filtrering på parametrar. |
| SampleSites | Hämtar information om provplatser. Urval på provplatsId eller genom filtrering på parametrar. |
| Stations | Hämtar information om stationer och deras tillhörande provplatser. Urval på stationsId eller genom filtrering på parametrar. |
Version 1
Våra öppna API:er gör det möjligt för applikationer att få tillgång till data och funktionalitet som återfinns i Miljödata MVM. Tjänsterna erbjuds som REST och SOAP tjänster och data kan hämtas i JSON eller XML formaten.
Typ av data och information som kan hämtas
- Stationsinformation
- Observationer och mätvärden
- Systemvärden
Våra web services
- ObservationsService.svc : stationsinformation, observationer och mätvärden
- DomainDefinitionsService.svc : systemvärden såsom enheter och parametrar
- SecureTokenService.svc : hanterar autentisering och utlämning av säkerhetstokens
Stationsinformation
REST https://miljodata.slu.se/MVM/ws/ObservationsService.svc/rest
SOAP https://miljodata.slu.se/MVM/ws/ObservationsService.svc
- GetSite(siteid) -> en station
- GetSitesByEuId(euid) -> en eller flera stationer
- GetSitesByName(name) -> en eller flera stationer
Observationer och mätvärden
REST https://miljodata.slu.se/MVM/ws/ObservationsService.svc/rest
SOAP https://miljodata.slu.se/MVM/ws/ObservationsService.svc
Se vidare manualen i PDF.
Systemvärden
REST https://miljodata.slu.se/MVM/ws/DomainDefinitionsService.svc/rest
SOAP https://miljodata.slu.se/MVM/ws/DomainDefinitionsService.svc
- GetUnits() -> alla enheter
- GetUnit(unitId) -> en enhet
- GetUnitByName(name) -> en enhet
- GetParameter(parameterCode) -> en parameter
- GetParameterList(parameterCategory, onlyMenuParameters) -> en parameterlista
Tokens och autentisering
REST https://miljodata.slu.se/MVM/ws/SecureTokenService.svc/rest
SOAP https://miljodata.slu.se/MVM/ws/SecureTokenService.svc
Notera att SecureTokenService enbart stödjer https.
- Login(userName, password) -> en säkerhetstoken
- IsValidToken(token) -> en boolean som berättar om en token är giltig eller ej
- LogOut(token) -> glöm ej att logga ut din session för att förstöra din temporära säkerhetstoken
