API's » Publiceren op Genealogie Online

Op Genealogie Online kunnen stamboomonderzoekers hun genealogische gegevens publiceren, inclusief afbeeldingen, zie ook de pagina Alle mogelijkheden op een rij. Data (in GEDCOM formaat) en gekoppelde afbeeldingen kunnen worden aangeleverd via e-mail of worden ge-upload via de self-service website mijn.genealogieonline.nl. Om directe upload vanuit een stamboomprogramma mogelijk te maken is deze API ontwikkeld.

Wanneer data (in GEDCOM formaat) en afbeeldingen voor de eerste keer worden aangeleverd via de Creatie functie van deze API dan worden deze (net als via e-mail aangeleverde data) eerst handmatig gecontroleerd, waarna verwerking plaatsvindt en de auteur via e-mail op de hoogte wordt gesteld van de locatie van de publicatie op Genealogie Online. Wanneer het een nieuwe publicatie betreft wordt deze niet automatisch "openbaar" gemaakt. Er wordt gevraagd of de publicatie naar wens is en de auteur wordt gewezen op de Wet Bescherming Persoonsgegevens en de noodzaak van bronvermeldingen.

Het updaten van een publicatie via de Bijwerken functie van de API (dus als een gebruiker de gegevens opnieuw aanbiedt) wordt geheel automatisch verwerkt. Deze verwerking gebeurt asynchroon (verwerking kan namenlijk enkele minuten duren), ook hiervan wordt de auteur weer via e-mail op de hoogte gesteld.

Op de startpagina's van publicaties die via deze API aangeboden worden wordt de naam (en link) van de stamboomprogramma leverancier opgenomen. Een overzicht van stamboomprogramma's die Genealogie Online auteurs gebruiken is te vinden op de pagina Gebruikte stamboomprogramma's.

Beschikbare methodes binnen deze API

Er zijn drie functies beschikbaar in de Publiceren op Genealogie Online service:

• Creatie - via deze functie kan de GEDCOM data en meta-informatie van een nieuwe publicatie aangeleverd worden;
• Bijwerken - via deze functie kan de GEDCOM data van een bestaande publicatie aangeleverd worden;
• Afbeeldingen - via deze functie kunnen afbeeldingen (zoals foto's en scans) die bij een publicatie horen (dus gekoppeld zijn aan personen in het GEDCOM bestand) aangeboden worden;
• Ping - via deze functie kan de beschikbaarheid van de publicatie service getest worden.

Wijziging

Per 1 september 2018 zullen de API's alleen werken als deze via https worden aangeroepen, anders wordt er een foutmelding (403) geretourneerd.

Per 25 januari 2020 zal er geen ondersteuning meer zijn van de zwakke protocollen TLS 1.0 en TLS 1.1.

Gebruik

Voorbeeld GUI

De gegevens die benodigd zijn voor het gebruik van deze API kan met de volgende voorbeeld GUI (in wizard vorm) aan de gebruiker van het stamboomprogramma worden gevraagd:

API sleutel

Voor het gebruik van deze API dient u (als software leverancier) eerst - gratis en eenmalig - een API sleutel aan te vragen via apicoret.org!

De volgende software leveranciers hebben een API sleutel aangevraagd:

• GensDataPro (de API wordt gebruikt in de productieversie van GensDataPro)
• Geneaal (de API wordt gebruikt in de productieversie van Geneaal)
• Aldfaer (nog geen gebruik van API in productieversie van Aldfaer)