CVR API er bygget op omkring REST principperne, hvilket betyder, at du skal bruge GET for at hente objekter. Du vil derudover også få returneret en sigende HTTP statuskode, som f.eks. fortæller om et objekt blev fundet eller ej.
Dette API er kun for betalende kunder.
CVR API kører kun med én adresse:
Som tidligere nævnt, er det ikke et krav at du bruger en nøgle for at bruge API'et, men du kan risikere at blive begrænset. For at minimere begrænsning, kan du verificere dig via HTTP basic.
curl --user 'nøgle:' https://rest.cvrapi.dk
Hvis du af en årsag ikke bruger en valid nøgle, så vil du modtage følgende svar:
HTTP/1.1 401 Not Authorized
Alle svar vil være i JSON. Du kan vælge og forespørge API'et for at få svaret i XML.
format=xml
Følgende headers vil være til rådighed.
Content-Type: [application/json | application/xml]
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE
API'et vil returnere en af følgende HTTP statuskoder, som du kan handle efter:
200 OK
201 Created
400 Bad Request
401 Unauthorized
404 Not Found
5xx Server Error
Når du bruger API'et, så er det en god idé, at tjekke for fejlbeskeder. Her vil det være oplagt, at altid tjekke på, om du får et svar tilbage, som i objektet indeholder 'error'.
QUOTA_EXCEEDED
Din IP-adresse eller IP-range er blevet begrænset midlertidigt - typisk ind til næste dag. Stop med opslag. Du har 50 gratis opslag om dagen. Kontakt, hvis du har brug for flere opslag.
BANNED
Din IP-adresse eller IP-range er blevet blokeret. Stop med opslag.
INTERNAL_ERROR
Der er sket en fejl. Skab endelig kontakt.
Du kan hente et virksomhedsobjekt via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/company/10150817
Svar eksempel:
Du kan hente et underenhedsobjekt via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/subsidiary/1003407806
Svar eksempel:
Du kan hente et deltagerobjekt via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/participant/4004213460
Svar eksempel:
Du kan få returneret en liste med foreslag på virksomhedsobjekter via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/suggestions/company/erhvervsstyrelsen
Svar eksempel:
Du kan få returneret en liste med foreslag på underenhedsobjekter via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/suggestions/subsidiary/erhvervsstyrelsen
Svar eksempel:
Du kan få returneret en liste med foreslag på deltagerobjekter via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/suggestions/participant/DEN%20DANSKE%20STAT
Svar eksempel:
Du kan få leveret en liste over senest ændrede virksomheder, ud fra det tidsstempel du indtaster. Tidstemplet kan maksimalt gå 7 dage bagud i tiden - gælder også klokkeslæt. Du henter informationen via et simpelt HTTP GET:
curl https://rest.cvrapi.dk/v1/dk/changed/company/2016-06-09T11:31:00
Svar eksempel:
| # | Tekst |
|---|---|
| 1 | Dekret |
| 2 | Ophævelse af dekret |
| 3 | Regnskab og boafslutning |
| 4 | Andre meddelelser |
| 5 | Indkaldelse til fordringsprøvelse |
| 6 | Skiftesamling |
| 7 | Andre meddelelser |
| 8 | Åbning af forhandling |
| 9 | Stadfæstelse |