Kort introduktion
API för anteckning är ett publikt REST-baserat API som Naturvårdsverket erbjuder för att kunna lämna uppgifter direkt till avfallsregistret.
Anslutning till API:et
Verksamheter som vill lämna uppgifter till avfallsregistret från sitt eget verksamhetsstödsystem kan ingå ett avtal med Naturvårdsverket för att ansluta till API:et. När avtal har ingåtts sker en så kallad teknisk onboarding.
Teknisk onboarding
- Naturvårdsverket granskar klient-certifikatet och att det stämmer med parten i avtalet.
- Naturvårdsverket skickar ut en API-nyckel (API token) för anslutning till avfallsregistrets testmiljö.
- Verksamheten konfigurerar sin miljö att använda certifikatet i anropen och genomför acceptanstester i testmiljön.
- Naturvårdsverket granskar testerna. Om det ser bra skickar Naturvårdsverket ut en API-nyckel (API token) för anslutning till avfallsregistrets produktionsmiljö.
- Klart att köra mot produktionsmiljön!
Service style
REST
Datautbytesformat
JSON
Transport security
Tvåvägsautentisering (mTLS) används varför det krävs ett klientcertifikat från en godkänd utfärdare.
Autentisering
OAuth2 Bearer används och i samband med anslutning får verksamhetsutövaren en access token med en ettårsgräns.
URL:er
- Produktionsmiljö
https://api.naturvardsverket.se/btfa/anteckning/v1/[resource name]...
- Testmiljö
https://api-test.naturvardsverket.se/btfa/anteckning/v1/[resource name]...
- Sandbox finns ej tillgängligt i dagsläget.
Språk
De flesta datafält är namngivna på svenska.
Request headers
NV-Client-System-ID (obligatoriskt) ska innehålla namn och version avseende det anslutande systemet.
NV-Client-Tracking-ID (frivilligt) returneras alltid I svaret och kan användas för att spåra förfrågan med ett valfritt id. Om man inte gör något val så kommer ett slumpmässigt UUID (Universal unique identifier, unik identifierare) att inkluderas i svaret.
Inlämnande av anteckningar via API
Ladda ner den tillgängliga swagger-filen för att ta del av API för anteckning.
Beskrivning av metoder och resurser
| Metoder | Resurs | Beskrivning |
| GET |
/anteckningstyper |
Värdelista över avfallsid. |
| GET |
/atervinningsresultattyper |
Värdelista över typer av återvinningsresultat vid behandling av spillolja. |
| GET |
/avfallstyper |
Värdelista över avfallstyper. |
| GET |
/behandlingsmetoder |
Värdelista över behandlingsmetoder. |
| GET |
/transportsatt |
Värdelista över transporttyper. |
| PUT, POST |
/transportplaneringar |
Anteckningstyp för avfallsproducentens transportplanering. |
| PUT, POST |
/transporter |
Anteckningstyp för transportör vid upphämtning av farligt avfall. |
| PUT, POST |
/insamlingar |
Anteckningstyp för insamlare, i anslutning till att avfallet tas emot. |
| PUT, POST |
/insamlingstransport |
Anteckningstyp för insamlare, i anslutning till att avfallet transporteras vidare. |
| PUT, POST |
/handel |
Anteckningstyp för handlare och mäklare. |
| PUT, POST |
/behandlingsmottaganden |
Anteckningstyp för behandlare, i anslutning till att avfallet tas emot. |
| PUT, POST |
/behandlingsresultat |
Anteckningstyp för behandlare, när avfallet har behandlats (kvartalsredovisning). |
| PUT, POST |
/behandlingsoverlamningar |
Anteckningstyp för behandlare, i anslutning till att avfallet transporteras vidare till en ny innehavare. |
Motsvarande lagstiftning
Tabellen nedan beskriver respektive metod i API:et och motsvarande paragraf i avfallsförordningens (2020:614) sjätte kapitel.
| Paragraf | Metod | Aktör |
| §5-1 |
/behandlingsmottaganden |
Behandlare av farligt avfall |
| §5-3 |
/behandlingsoverlamningar |
Behandlare av farligt avfall |
| §5-2 |
/handel |
Behandlare av farligt avfall |
| §4 |
/behandlingsresultat |
Mäklare av farligt avfall |
| §3-1 |
/insamlingar |
Insamlare av farligt avfall |
| §3-2 |
/insamlingstransport |
Insamlare av farligt avfall |
| §2 |
/transporter |
Transportör av farligt avfall |
| §1 |
/transportplaneringar |
Producent av farligt avfall |
Exempel GET
GET https://api-test.naturvardsverket.se/btfa/anteckning/v1/avfallstyper
Authorization : Bearer xxXx0x0x0x0xxXXX000xx . . .
NV-Client-System-ID : My-system-version-1.1
NV-Client-Tracking-ID: 3.1415297
|
Exempel POST
POST https://api-test.naturvardsverket.se/btfa/anteckning/v1/behandlingsmottaganden
Content-Length: 342
Content-Type: application/json; charset=UTF-8
Authorization: Bearer xxXx0x0x0x0xxXXX000xx . . .
NV-Client-System-ID: My-system-version-1.1
NV-Client-Tracking-ID: 3.1415927
{
"tidpunktForAnteckningen": "2019-11-25T10:07:19",
"datumForAvfalletsMottagande": "2019-11-25",
"ombud": "1212121212",
"verksamhetsutovare": "2021001975",
"referens": "876182763",
"avfall": {
"kod": "010305",
"mangd": 1000.00,
"foreganendeavfallid": "0d2e3ec4-c84a-40fc-8711-a00b5cd4c6cd"
},
"tidigareInnehavare": "2021001975"
}
|
Response
För samtliga POST- eller PUT-operationer innehåller varje response body fältet AvfallsID som är ett unikt id för respektive skapade eller uppdaterade uppgift. Detta värde bör användas när man rapporterar efterföljande händelser, för att på så sätt länka samman olika anteckningar och förbättra spårbarheten för respektive avfallsmängd.
Exempel:
HTTP/1.1 201 Created
Date: 2020-09-04 18:34:04
Connection: Keep-Alive
Content-Type: application/json; charset=UTF-8
Content-Length: 63
NV-Client-Tracking-ID: 3.1415927
{
"AvfallsId": "072f294c-9e70-4cf6-b6a3-139922067ddc"
}
|
Checklista för test av integration
- Verifiera att alla anrop fungerar – både POST och PUT – skicka underlag till Naturvårdsverket för verifiering.
- Utför tester med den förväntade mängden anrop.
- Skicka testrapporter och protokoll på utförda tester till Naturvårdsverket