You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Denne side beskriver hvordan du som anvender af Datafordeleren kan oprette forbindelse til at abonnere på hændelser for et givent register. 

Der tages udgangspunkt i at abonnere på hændelser for et enkelt register, herunder BBR. Processen vil være den samme for registrene, registernavnet skal bare udskiftes til det register du ønsker at abonnere på hændelser for.

Læs mere om hændelser.


Sideinformation


Andre metoder til vedligeholdelse af kopiregister

Til toppen

Ønsker du ikke at bruge hændelser, kan du benytte deltadownloads der kommer én gang i døgnet, eller det ugentlige totaldownload. Hvilken metode du vælger at benytte til at vedligeholde dit kopiregister, kommer an på hvor hurtigt du som anvender har behov for at behandle den nye data.

Bemærk: Hændelser er det eneste måde hvor du som anvender eksplicit kan finde data der er blevet slettet, grundet at Datafordeleren ikke udstiller slettet data.

Hentning af totaldownloads er beskrevet i [C0200-FildownloadKopiregister].





Forudsætninger og afgrænsninger

Til toppen

Følgende forudsætninger og afgrænsninger gælder for at kunne følge guiden:

  • Denne guide antager at du som anvender har grundlæggende kendskab til hændelser, som kan findes under Entitetsbaserede hændelser. Her findes generel information om hændelser, brugsscenarier, samt beskrivelse af de data der er udstillet, hvad de betyder og hvordan de kan benyttes.
  • Guiden omhandler kun hvordan tekniske hændelser kan hentes af anvendere. Med tekniske hændelser, menes der hændelser vedrørende opdateringer af registerdata. Denne guide indebærer ikke forretningshændelser, defineret ud fra registrenes egen forretningslogik.
  • Du skal have oprettet en bruger på Datafordeler Administrationen. Se vejledning til dette på Brugeroprettelse Datafordeler Administration.
  • Guiden forudsætter at et kopiregister allerede er oprettet, der sektionen ”Totaldownload for entitet” i [C0200-FildownloadKopiregister] kan tages som udgangspunkt. 





Sådan abonnerer du på hændelser


Ligesom entitetsbaserede GraphQL-tjenester, tilgås hændelser via et GraphQL-API. Hændelser tilgås på registerbasis og kræver at du benytter Datafordelerens autentifikation, det vil sige en OAuth hvis der er tale om et register med beskyttede registerdata og API-key til registre med ikke-beskyttede registerdata.

Opsætning med API-key er nærmere beskrevet API-Key, og opsætning med OAuth er nærmere beskrevet under Autentifikation og autorisation for GraphQL-tjenester.

Derudover bruger Datafordeleren i visse tilfælde en IP-allowlist til at verificere om klienten (dit eget IT-system) er autoriseret til at hente det efterspurgte data.

Når dit IT-system sender en forespørgsel til GraphQL-tjenesten med gyldig authentificering og adgang, returneres en stream som IT-systemet kan lytte på.

Efter 10 minutter bliver forbindelsen termineret, men en nye kan oprettes med det samme for at i praksis have en konstant forbindelse.





Eksempler på brug af tjenesten


Abonnering på hændelser ligner kald til de entitetsbaserede GraphQL-tjenester, dog med den forskel at forespørgsler der indsendes med et subscription præfix i stedet for query, og at der ikke er nogen paging grundet at en hændelse bliver returneret ad gangen.

Nedenstående eksempel kalder hændelser for BBR og efterspørger alle de tilgængelige kolonner for hændelsesdata.


subscription {
    BBR_Events {
        eventid
        entityname
        eventaction
        fromfailedimport
        datafordelerRegisterImportSequenceNumber
        datafordelerOpdateringstid
        object_id
        object_datafordelerRowId
        object_datafordelerRowVersion
        object_status
        object_registreringfra
        object_registreringtil
        object_virkningfra
        object_virkningtil
    }
}



Hændelser er udstillet på de samme URL’er som de entitetsbaserede tjenester, derfor kan oprettelse af abonnering på et register, i dette eksempel BBR, kaldes på følgende URL med en API-key som autentificering:

  • https://graphql.datafordeler.dk/BBR/v1?apiKey=placeholderNoegle










  • No labels