Utvikling og fornying av registertjenester på Brønnøysundregistrenes nye registerplattform vil foregå i flere år fremover.
Tilgjengeliggjøring av registerdata gjennom API’er er en viktig del av tjenestetilbudet for registertjenestene. I GitHub vil vi samle dokumentasjon for de nye API’ene som er ferdig.
I tillegg vil vi så tidlig som mulig også publisere dokumentasjon for API’er som under utvikling, men foreløpig ikke tatt i bruk.
Eldre API’er er fortsatt dokumentert andre steder, f.eks på Brønnøysundrestrenes hjemmeside eller i dokumentasjon som distribueres ved forespørsel.
For ytterligere informasjon om eldre tjenester, se https://www.brreg.no/produkter-og-tjenester/apne-data/ og https://www.brreg.no/produkter-og-tjenester/bestille-produkter/abonnement/.
Disse sidene vil være et område hvor vi publiserer generell informasjon, tjenestebeskrivelser, informasjonsmodeller, testdata,
osv. - som et supplement til den tekniske dokumentasjonen som vil publiseres som maskinlesbare OpenAPI-spesifikasjoner.
I OpenAPI-spesifikasjonen vil det bl.a. ligge eksempler på request og respons, feltbeskrivelser,
og annet som gjør at f. eks. godt utbredte Swagger blir et godt verktøy for å utforske og forstå API-ene.
OpenAPI-spesifikasjonene vil også tilgjengeliggjøres gjennom Felles API-katalog,
som vil sørge for at API-ene enklere kan oppdages av de som måtte være interesserte, og inneholde en link tilbake til dokumentasjonen som ligger på disse sidene.