Ga naar hoofdinhoud

Aansluiten op de Directory

RINIS host de directory voor de DigikoppelingGroep. De Directory faciliteert de uitwisseling van informatie tussen partijen in een Groep door het publiceren van de partijen en de services die ze aanbieden.

Functionaliteiten​

De Directory biedt de volgende functionaliteiten:

  • Andere partijen vinden
  • Services vinden
  • Services publiceren
  • Registreren van partijen

Digikoppeling Groep​

Als u FSC wil toepassen via Digikoppeling kunt u aansluiten bij de Digikoppeling Groep. Deze Groep voldoet aan het Digikoppeling REST API profiel.

Aansluiten​

Aansluiten op de Directory bestaat uit drie eenvoudige stappen

  1. Voorbereiding
  2. Registreer uw organisatie(onderdeel) in de Directory als partij met behulp van uw PKIoverheidcertificaat
  3. Gebruik de Directory, afhankelijk van uw behoefte:
    • Publiceer uw Services
    • Gebruik de Directory om de adressen van partijen op te zoeken

1. Voorbereiding​

Er zijn een aantal randvoorwaarden voor het gebruik van de Directory:

  1. Zorg ervoor dat u beschikt over een PKIoverheidscertificaat. Als u hier niet over beschikt kunt u dit aanvragen bij Logius.
  2. Zorg ervoor dat u beschikt over een FSC Manager component om uw organisatie als partij aan te melden en om services te publiceren. Als u gebruik maakt van een gedelegeerde partij voor de uitwisseling, dan moeten zowel de gedelegeerde partij als de delegatiegever over een Manager component beschikken om de publicatieverzoeken te ondertekenen en zichzelf te registreren in de directory. Zie voor meer informatie de technische documentatie en de standaard.
  3. Uw FSC implementatie moet voldoen aan het Digikoppeling REST API profiel. Dit betekent onder andere dat logging geïmplementeerd moet zijn en dat u moet beschikken over een PKIoverheidscertificaat.

Als u aan de randvoorwaarden voldoet, neem dan contact op met RINIS voor de technische informatie van de Manager. Uiteraard kunt u ook contact opnemen als u vragen heeft over bovenstaande randvoorwaarden.

2. Registreer uw organisatie(onderdeel)​

Om de Directory te kunnen bevragen en Services te kunnen publiceren dient u zichzelf te registreren als partij in de Directory. Dit gebeurt via uw FSC Manager Component, deze moet daarom geïnstalleerd zijn in uw omgeving (zie voorbereiding).

Registratie gebeurt door via het /announce endpoint met als headerparameter het adres van de Manager die gebruikt wordt. De directory legt dan de Peer ID, Peer name en het Manager adres vast. Dit betekent dat een partij de lijst van groepsleden raadpleegt, uw gegevens worden getoond. Deze registratie gebeurt automatisch bij het opstarten van de Manager, hiervoor hoeft u zelf geen actie uit te voeren.

3. Gebruik de directory​

U kunt de Directory gebruiken voor het publiceren van Services of voor het opzoeken van partijen en Services.

Publiceren van services​

Voor iedere Service die u wilt publiceren in de Directory wordt een Contract vastgelegd in de Directory met de volgende gegevens:

  1. Een UUID voor het veld contract.iv. U bent verantwoordelijk voor het aanleveren van een UUID.
  2. Een hash algoritme dat gebruikt wordt voor de handtekening van het contract
  3. Datum dat het contract is gecreëerd. Dit kan niet in de toekomst liggen
  4. Datum geldig vanaf (validity_not_before)
  5. Datum geldig tot (validity_not_after), deze datum moet groter zijn dan de datum geldig vanaf en moet in de toekomst liggen.
  6. De naam service die u wil publiceren (ServicePublicationGrant)

U kunt met uw FSC Manager component een publicatieverzoek indienen bij de Directory. De volgende gegevens van de service worden vastgelegd in de directory:

  1. PeerID. Dit is uw OIN
  2. De naam van de Service. Dit is een string van minimaal 3 en maximaal 255 karakters
  3. Protocol dat gebruikt moet worden, dit is of HTTP 1.1 of HTTP 2

Het publicatieproces is hiermee afgerond. Om de service daadwerkelijk ter beschikking te stellen voor uitwisseling is naast de Manager ook een Inway component nodig.

Opzoeken van partijen​

U kunt de Services van de Directory opvragen via de APIs van de directory.

/peers Voor het opvragen van peers kunt u een filter opgeven: PeerID en/of PeerName
/services Voor het opvragen van Services kunt u een filter opgeven: PeerID en/of ServiceName

U kunt ook in de directory browsen via de user interface. De link krijgt u nadat u contact heeft opgenomen met RINIS om u aan te melden voor de groep.

Voor het daadwerkelijk gebruiken van de services die u heeft opgezocht is naast een Manager ook een Outway component nodig.

Delegatie​

Als u zelf niet de bron bent van de Service, maar dit doet namens een bronhouder, dan publiceert u de Service via een DelegatedServicePublicationGrant. Als u gebruik wil maken van een Serivce namens een Peer, dan doet u dat via een DelegatedServiceConnectionGrant

Contact​

Als u wil aansluiten op de Directory van de Digikoppeling Groep of vragen heeft over de dienstverlening van RINIS kunt u een mail sturen naar accountmanagement@rinis.nl