BITS
Informasjon om api-endepunkter hos norske finansinstitusjoner
Distribusjonsstøttetjeneste for å utlevere finansinstitusjoners api-endepunkter i forbindelse med kontrollinformasjon og utleggspant
Tjenestebeskrivelse
BITS kontrollinformasjon og utleggspant er et ledd i DSOP-tjenester basert på DSOP FinansData Fellesstandard der offentlige etater får utlevert opplysninger fra finansnæringen maskinelt. For mer informasjon, se her.
Hvem kan bruke informasjonen
BITS datadelingstjenester er tilgjengelig for Altinns tjenesteeiere som også benytter tjenester basert på DSOP FinansData Fellesstandard (tidligere DSOP Kontrollinformasjon).
Overordnet informasjon om datasett
Kontrollinformasjon - utleverer til enhver tid gjeldende endepunkter som benyttes for tjenester basert på DSOP FinansData Fellesstandard.
KontrollinformasjonUtvidet - utleverer til enhver tid gjeldende og fremtidige endepunkter som benyttes av tjenester basert på DSOP FinansData Fellesstandard. Det vil si at det kan finnes flere innslag per organisasjonsnummer, men med forskjellige start- og sluttdatoer, slik at man kan forberede endringer i infrastruktur i forkant av at endepunktene aktiveres.
Utleggspant - utleverer til enhver tid gjeldende og fremtidige endepunkter som benyttes av tjenester som benytter seg av BlockFund API-et. Det vil si at det kan finnes flere innslag per organisasjonsnummer, men med forskjellige start- og sluttdatoer, slik at man kan forberede endringer i infrastruktur i forkant av at endepunktene aktiveres.
Hvordan ta tjenesten i bruk
Hente test-endepunkter:
Opprett en bruker på test.data.altinn.no og be om tilgang til produktet «BITS kontrollinformasjon» (gjelder for tilgang til samtlige datasett).
Etter godkjenning vil man få en api-nøkkel som må legges ved når man etterspør endepunktene. I tillegg må man definere en klient i maskinportens test-miljø som har tilgang på scopet altinn:dataaltinnno/kontrollinformasjon for Kontrollinformasjon og KontrollinformasjonUtvidet - altinn:dataaltinnno/utleggspant for Utleggspant. Scopene vil være forhåndstildelt til de aktuelle aktørene både i test og produksjon. Dette er for å sikre bruken at konsumentgruppen er i henhold til nåværende juridiske føringer på bruk av Altinn-løsninger.
For å hente data må man gjøre en spørring mot test-api.data.altinn.no og det aktuelle datasettet. Beskrivelsen av selve datasettet finnes nederst på denne siden (hak av for vis testmiljø).
Kontrollinformasjon
GET https://test-api.data.altinn.no/v1/directharvest/Kontrollinformasjon/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger (generert, ikke reell):
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": https://api.navn.no/dsopaccountcontrolinfo/v2/AccountControlInfoService/v2/837884942,
"version": "v2",
"env" : "test"
},
{
"orgNo": "987654321",
"name": "NAVN PÅ ANNEN BANK",
"url": https://api.annenbank.no/dsopaccountcontrolinfo/v1/AccountControlInfoService/v2/920426530,
"version": "v1",
"env" : "test"
}
]
KontrollinformasjonUtvidet
GET https://test-api.data.altinn.no/v1/directharvest/KontrollinformasjonUtvidet/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger:
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": "https://api.annenbank.no/dsopaccountcontrolinfo/v1/AccountControlInfoService/v2/920426530",
"version": "v2",
"env" : "test",
"fromDate" :"2022-09-05T09:24:28.148Z",
"toDate" : "2022-09-15T09:00:00.000Z"
},
{
"orgNo": "12345678",
"name": "NAVN PÅ BANK",
"url": https://api.annenbank.no/dsopaccountcontrolinfo/v2/AccountControlInfoService/v2/920426530,
"version": "v1",
"env" : "test",
"fromDate" :"2022-09-15T09:00:01.000Z"
}
]
Utleggspant
GET https://test-api.data.altinn.no/v1/directharvest/Utleggspant/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger:
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": "https://api.enbank.no/blockfundapi/920426530",
"version": "v2",
"env" : "test",
"fromDate" :"2022-09-05T09:24:28.148Z",
"toDate" : "2022-09-15T09:00:00.000Z"
},
{
"orgNo": "12345678",
"name": "NAVN PÅ BANK",
"url": "https://api.annenbank.no/blockfundapitilannenbabnk/920426530",
"version": "v1",
"env" : "test",
"fromDate" :"2022-09-15T09:00:01.000Z"
}
]
Hente prod-endepunkter:
Kontrollinformasjon
Opprett en bruker på data.altinn.no og be om tilgang til produktet «BITS kontrollinformasjon» (gjelder for tilgang til samtlige datasett). Etter godkjenning vil man få en api-nøkkel som må legges ved når man etterspør endepunktene.I tillegg må man definere en klient i maskinportens test-miljø som har tilgang på scopet altinn:dataaltinnno/kontrollinformasjon for Kontrollinformasjon og KontrollinformasjonUtvidet - altinn:dataaltinnno/utleggspant for Utleggspant. Scopene vil være forhåndstildelt til de aktuelle aktørene både i test og produksjon. Dette er for å sikre bruken at konsumentgruppen er i henhold til nåværende juridiske føringer på bruk av Altinn-løsninger.
For å hente data må man gjøre en spørring mot api.data.altinn.no og det datasettet man ønsker å hente. Beskrivelsene av datasettene finnes nederst på denne siden.
GET https://api.data.altinn.no/v1/directharvest/Kontrollinformasjon/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger:
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": https://api.navn.no/dsopaccountcontrolinfo/v2/AccountControlInfoService/v2/837884942,
"version": "v2",
"env" : "prod"
},
{
"orgNo": "987654321",
"name": "NAVN PÅ ANNEN BANK",
"url": https://api.annenbank.no/dsopaccountcontrolinfo/v1/AccountControlInfoService/v2/920426530,
"version": "v1",
"env" : "prod"
}
]
KontrollinformasjonUtvidet
GET https://api.data.altinn.no/v1/directharvest/KontrollinformasjonUtvidet/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger:
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": "https://api.annenbank.no/dsopaccountcontrolinfo/v1/AccountControlInfoService/v2/920426530",
"version": "v2",
"env" : "prod",
"fromDate" :"2022-09-05T09:24:28.148Z",
"toDate" : "2022-09-15T09:00:00.000Z"
},
{
"orgNo": "12345678",
"name": "NAVN PÅ BANK",
"url": https://api.annenbank.no/dsopaccountcontrolinfo/v2/AccountControlInfoService/v2/920426530,
"version": "v1",
"env" : "prod",
"fromDate" :"2022-09-15T09:00:01.000Z"
}
]
Utleggspant
GET https://api.data.altinn.no/v1/directharvest/Utleggspant/?envelope=false HTTP/1.1
Authorization: Bearer {maskinporten-token}
Ocp-apim-subscription-key: {subscription-key}
Dette vil gi en respons som ser ut som følger:
[
{
"orgNo": "123456789",
"name": "NAVN PÅ BANK",
"url": "https://api.enbank.no/blockfundapi/920426530",
"version": "v2",
"env" : "test",
"fromDate" :"2022-09-05T09:24:28.148Z",
"toDate" : "2022-09-15T09:00:00.000Z"
},
{
"orgNo": "12345678",
"name": "NAVN PÅ BANK",
"url": "https://api.annenbank.no/blockfundapitilannenbabnk/920426530",
"version": "v1",
"env" : "test",
"fromDate" :"2022-09-15T09:00:01.000Z"
}
]
Varsling om nedetid og planlagte endringer
Data.altinn.no vil sende ut varsel til konsumenter ved planlagt nedetid, endringer som påvirker tjenesten osv.
Konsumenter vil varsles via BITS varslingsrutine og motta informasjon om følgende:
- Identifikator på varselet (issue på github)
- Data.altinn.no/bits kontrollinformasjon
- Om varselet gjelder endring/nedetid/annet
- Hvilket miljø det gjelder
- Beskrivelse
- Start- og slutt-tidspunkt
- Status