7.1. Ophalen AFD-definities

Gecertificeerde AFD-definities worden gepubliceerd in het AOS-register voor AFD-definities. Doel: periodiek bijwerken van de administratie (productinrichting) met de meest recente AFD-definities. Dit register kent twee manieren van ontsluiting:

1. Toegang via AOS-webportaal (zie hoofdstuk AOS-Register)

• Een AFD-definitie kan op 3 manieren in het register staan:
  

1. Niet zichtbaar: AFD-definitie is onzichtbaar voor gebruikers, alleen de beheerder van het register binnen de organisatie ziet de AFD-definitie.
2. Zichtbaar: AFD-definitie is zichtbaar voor gebruikers.
3. Downloadbaar: AFD-definitie is zichtbaar en downloadbaar voor geautoriseerde gebruikers.
   

2. Toegang via AOS-API (REST)

• De API bevat twee functies:
  

1. Ophalen overzicht nieuwe AFD-definities op basis van ‘vanaf-datum’ parameter.
2. Downloaden AFD-definities (zip-files).
   • Alleen de als downloadbaar aangemerkte AFD-definities kunnen worden gedownload, de andere AFD-definities zal men moeten opvragen bij de betreffende organisatie

Met de AOS-API is het mogelijk geautomatiseerd AFD-definities op te halen om deze (semi-)automatisch te verwerken in je eigen omgeving. De AOS-API bevat dezelfde AFD-definities als het register in het AOS-webportaal.

Hoe werkt de AOS-API?

1. Een overzicht van gepubliceerde AFD-definities is op te vragen op basis van gekozen vanaf-datum.
2. Per gevonden AFD-definitie komt detailinformatie terug. Het advies is op basis van deze kenmerken een registratie (database) in te richten van in gebruik zijnde AFD-definities. Op basis van de kenmerken kun je controleren of je een AFD-definitie moet actualiseren of toevoegen.
3. Elke gevonden AFD-definitie bevat een sleutel (een combinatie van gegevens). Met deze sleutel kun je in de tweede API-functie de AFD-definitie downloaden en toevoegen aan de registratie van AFD-definities.
4. Met de opgehaalde AFD-definities kun je je eigen omgeving handmatig of geautomatiseerd inrichten of bijwerken.

In de volgende paragrafen wordt de technische werking toegelicht. Daarbij wordt gestart met uitleg over de authenticatie om vervolgens de werking van de inhoudelijke service te beschrijven.

Swaggerhub

De gedetailleerde technische API-specificatie is beschikbaar via SwaggerHub: https://app.swaggerhub.com/apis/SIVI_API_Framework/AFD-definition/1.1.0