diff --git a/_header/index.html b/_header/index.html index b9a37ed4..0d58a450 100644 --- a/_header/index.html +++ b/_header/index.html @@ -1,4 +1,4 @@ -:: BR dokumentasjon +:: BR dokumentasjon

Uthenting av meldinger

Innledning

Brønnøysundregistrenes elektroniske mottak har et REST-grensesnitt som kan benyttes av eksterne parter for innsending av meldinger.

Sikkerhetsmekanismer

Siden dette er begrensede API så skal kallende parter autentiseres gjennom Maskinporten.

For å kunne få tilgang til våre begrensede APIer må man bruke et JWT-token fra Maskinporten med scopet brreg:mottak

Access-tokenet oppgis i headeren Authorization. Husk Bearer før tokenet.

HeaderVerdi
AuthorizationBearer

Grensesnittbeskrivelse

Swagger

Tjenesten benytter seg av standard HTTP GET og POST.

HTTP-metodeURLContent-typeBeskrivelseSikret med jwt
GEThttps://mottak.brreg.no/outbound/availableapplication/jsonLister ut tilgjengelige meldinger (med mottakId) for organisasjonsnummer oppgitt i JWT tokenetJA
GEThttps://mottak.brreg.no/outbound/download?mottakId={mottakId}application/octet-streamLaster ned forsendelse med oppgitt mottakIdJA
PUThttps://mottak.brreg.no/outbound/confirm?mottakId={mottakId}application/jsonBekrefter at forsendelse med oppgitt mottakId er lastet ned av klientJA

/available

Endepunktet returnerer tilgjengelige forsendelser for organisasjonsnummer som er oppgitt i JWT-tokenet.

Response

Ved 200 OK:

[
+BR docs > API-dokumentasjon > Elektronisk mottak > Integrasjon direkte mot BR > Uthenting av meldinger

Uthenting av meldinger

Innledning

Brønnøysundregistrenes elektroniske mottak har et REST-grensesnitt som kan benyttes av eksterne parter for innsending av meldinger.

Sikkerhetsmekanismer

Siden dette er begrensede API så skal kallende parter autentiseres gjennom Maskinporten.

For å kunne få tilgang til våre begrensede APIer må man bruke et JWT-token fra Maskinporten med scopet brreg:mottak

Access-tokenet oppgis i headeren Authorization. Husk Bearer før tokenet.

HeaderVerdi
AuthorizationBearer

Grensesnittbeskrivelse

Swagger

Tjenesten benytter seg av standard HTTP GET og POST.

HTTP-metodeURLContent-typeBeskrivelse
GEThttps://mottak.brreg.no/outbound/availableapplication/jsonLister ut tilgjengelige meldinger (med mottakId) for organisasjonsnummer oppgitt i JWT tokenet. Kan filtreres på tjeneste og dato
GEThttps://mottak.brreg.no/outbound/downloadapplication/octet-streamLaster ned forsendelse med oppgitt mottakId
PUThttps://mottak.brreg.no/outbound/confirmapplication/jsonBekrefter at forsendelse med oppgitt mottakId er lastet ned av klient

available

Eksempel /available?tjeneste={tjeneste}&fraDato={fraDato}&tilDato={tilDato}

Endepunktet returnerer tilgjengelige forsendelser for organisasjonsnummer som er oppgitt i JWT-tokenet.

Man kan filtrere resultatene på disse parametrene hvis man ønsker

parametertypepåkrevd
tjenestestringnei
fraDatoLocalDatenei
tilDatoLocalDatenei

Response

Ved 200 OK:

[
   {
   "mottakId":"be935814-c7a3-4a9f-8bbc-ac278cbe41d5",
   "version":0,
@@ -49,12 +49,12 @@
   "oppdatert":"2019-09-05T09:43:51.691"
   }
 ]
-

/download?mottakId={mottakId}

Endepunktet returnerer ZIP-fil med Melding for angitt mottakId. MottakId er en UUID.

Response

Bytestream som APPLICATION_OCTET_STREAM

/confirm?mottakId={mottakId}

Endepunktet bekrefter forsendelsen med angitt mottakId som nedlastet. MottakId er en UUID.

Denne forsendelsen vil da ikke lenger fremkomme ved kall til /available.

Response

200 OK ved success.

Feilmeldinger

HTTP-kodeApplikasjonsfeilkodeFeilmelding
500 Internal Server ErrorERROR-00005Optimistic lock exception. Hvis samme forsendelseinfo blir forsøkt confirmed nedlastet samtidig kan dette skje. I utgangspunktet kan man se bort i fra denne, men å forhindre dette er klientens ansvar.

Disse kommer på JSON-formatet:

{
+

download

Eksempel /download?mottakId={mottakId}

Endepunktet returnerer ZIP-fil med Melding for angitt mottakId

Parametre

parametertypepåkrevd
mottakIdUUIDja

Response

Bytestream som APPLICATION_OCTET_STREAM

confirm

Eksempel /confirm?mottakId={mottakId}

Endepunktet bekrefter forsendelsen med angitt mottakId som nedlastet. Denne forsendelsen vil da ikke lenger fremkomme ved kall til /available-endepunktet.

Parametre

parametertypepåkrevd
mottakIdUUIDja

Response

200 OK ved success.

Feilmeldinger

HTTP-kodeApplikasjonsfeilkodeFeilmelding
500 Internal Server ErrorERROR-00005Optimistic lock exception. Hvis samme forsendelseinfo blir forsøkt confirmed nedlastet samtidig kan dette skje. I utgangspunktet kan man se bort i fra denne, men å forhindre dette er klientens ansvar.

Disse kommer på JSON-formatet:

{
   "feilId":"72577aa8-0ba1-4424-a310-fd9671547953",
   "mottakId":"fe7234ec-b51f-47d1-a414-5b17123118b3",
   "kilde":"maskinport-agent",
   "feilkode":"ERROR-00005",
   "beskrivelse": "Simultaneous attempt to confirm same file"
 }
-

I tillegg kommer 401 - Unauthorized ved mangler på Bearer token.

HTTP-kodeheaderHeader-valueForklaring
401 - UnauthorizedWWW-AuthenticateBearer realm=“unspecified”, error=“unauthorized”, error_description=“Full authentication is required to access this resource”JWT access token ikke oppgitt i Authorization header i request.
401 - UnauthorizedWWW-AuthenticateBearer realm=“unspecified”, error=“invalid_token”, error_description=“invalid bearer token or wrong scope for bearer token”JWT access token er oppgitt, men det er enten ugyldig (utgått, korrupt eller gjeldende for et annet scope en tjenesten krever).

I tillegg kommer 401 - Unauthorized ved mangler på Bearer token.

HTTP-kodeheaderHeader-valueForklaring
401 - UnauthorizedWWW-AuthenticateBearer realm=“unspecified”, error=“unauthorized”, error_description=“Full authentication is required to access this resource”JWT access token ikke oppgitt i Authorization header i request.
401 - UnauthorizedWWW-AuthenticateBearer realm=“unspecified”, error=“invalid_token”, error_description=“invalid bearer token or wrong scope for bearer token”JWT access token er oppgitt, men det er enten ugyldig (utgått, korrupt eller gjeldende for et annet scope en tjenesten krever).

Testmiljø

URL mot PPE-testmiljø er https://mottak.ppe.brreg.no/outbound

\ No newline at end of file diff --git a/apidokumentasjon/enhetsregisteret/index.html b/apidokumentasjon/enhetsregisteret/index.html index 493a900d..feb566c6 100644 --- a/apidokumentasjon/enhetsregisteret/index.html +++ b/apidokumentasjon/enhetsregisteret/index.html @@ -1,4 +1,4 @@ -Enhetsregisteret :: BR dokumentasjon +Enhetsregisteret :: BR dokumentasjon