Help:Nl:API Documentatie

Search WikiTree's help pages:

Categories: WikiTree Help (NL) | WikiTree Apps Project

Er is een standaard API beschikbaar voor elk WikiTree lid dat via zijn codeervaardigheden een bijdrage wil leveren aan de community. Het ondersteunt query's voor verschillende gegevenselementen in WikiTree profielen.

Als je nog vragen hebt, voeg je jezelf toe aan de WikiTree Apps Google Discussiegroep en vraag je ernaar. Bedankt! - Chris Whitten

Contents

Toegang tot de WikiTree API

De WikiTree API is toegankelijk via HTTP-aanroepen naar poort 80. Een aanroep moetworden gemaakt naar https://apps.wikitree.com/api.php

Dit is geen API met volledige functionaliteit. De API is alleen-lezen en ondersteunt alleen deze functies:

  • login: Verificeer een bepaald gebruikersaccount.
  • getProfile: de functie getProfile retourneert een standaardset velden voor een bepaalde sleutel (WikiTree ID of pagina ID-nummer). Deze standaardset bevat de verschillende naamvelden, geboortedatum/overlijdensdatum, geslacht en de moeder- en vader-ID-waarden. Naast deze standaardwaarden zijn er optionele velden die u kunt opvragen met behulp van de parameter "velden". Deze aanvullende velden zijn: Ouders, kinderen, broers en zussen en echtgenoten. Als u deze velden opvraagt, bevat de geretourneerde JSON persoonsprofielgegevens voor de relevante personen.
  • getPerson: de getPerson functie is grotendeels verouderd ten gunste van de meer flexibele getProfile. Het werkt echter nog steeds en kan nuttig zijn als je toepassing een profiel moet aanroepen met een gebruikers ID, in plaats van het paginanummer dat door getProfile wordt gebruikt (bijvoorbeeld om een moeder/vader ID te gebruiken om de profielgegevens van die ouder te verkrijgen). Het accepteert een "velden" parameter en retourneert gegevens precies zoals getProfile. Het enige verschil is de acceptatie van een gebruikers ID voor de sleutel.
  • getAncestors : Haal de voorouders van een bepaald persoon op.
  • getRelatives: Haal gezinsleden op in alle richtingen, niet alleen de voorouders.
  • getPrivacyLevels: Geeft een samenvatting van de privacy level codes.

De toegang tot de interface api.php is openbaar bereikbaar vanuit elke bron. Als je de API echter vanuit Javascript in een webpagina wilt oproepen, moet die pagina worden gehost op apps.wikitree.com vanwege de beveiliging van scripts op meerdere domeinen in browsers.

Als je een directory op de Apps-server voor jezelf wilt maken - of je nu een echte applicatie wilt uploaden of gewoon wilt experimenteren - sluit jezelf dan aan bij het WikiTree Apps Project.

Bibliotheken zijn in ontwikkeling om het gebruik van API te demonstreren in zowel Python als Javascript.

Als je niet weet waar je moet beginnen, hoef je jezelf geen zorgen te maken. E-mail <WikiTreeApps@googlegroups.com> en onze gebruikers gemeenschap zal je helpen.

Gegevens op Apps Server

De API roept gegevens op van de appserver van WikiTree. Dit zorgt ervoor dat apps de normale werking van WikiTree niet kunnen verstoren.

De App-data gegevens moeten in wezen gelijk zijn aan de live data gegevens. Het gebruikt een alleen-lezen kopie van de primaire WikiTree-database. Er zijn momenten dat als er grote wijzigingen worden aangebracht in de live server, de Apps-kopie korte tijd achterblijft (het is een minder capabele machine), maar meestal is het binnen enkele seconden of minder volledig up-to-date met de live data gegevens .

Beveiliging

De WikiTree API breidt het bestaande Vertrouwens lijst beveiligingsmodel van de WikiTree website uit. Informatie die door de API wordt geretourneerd, is beperkt tot alleen datgene wat beschikbaar is voor de huidige aangemelde gebruiker.

Elk WikiTree lid kan inloggen op een app die op apps.wikitree.com wordt uitgevoerd, tenzij u uw toepassing verbergt.

Parameters

De WikiTree API vereist bepaalde parameters om de gewenste resultaten te retourneren. Twee parameters zijn gemeenschappelijk voor alle functies. Dit zijn:

  • actie: De uit te voeren actie/functie (bijvoorbeeld "getProfile").
  • formaat: Het formaat van de geretourneerde gegevens. Dit is "json", voor JSON (JavaScript Object Notation) of "xml" voor XML (Extensible Markup Language). De standaardinstelling is dat gegevens worden geretourneerd in JSON.

In aanvulling op de "actie" en de "indeling" accepteren verschillende API-functies andere parameters.

login

email: Het e-mailadres van het WikiTree-account waarmee u inlogt.

wachtwoord: jouw wachtwoord.

getProfile

De functie getProfile werkt voor persoonsprofielen en vrije ruimte profielen.

key: dit is ofwel de Person.Name (WikiTree ID, bijv. "Adams-35"), de space page_name (bijv. "Space: Allied_POW_camps"), of het integer profiel PageId.

velden: Deze parameter beschrijft welke velden uit het persoonsprofiel je wilt dat de API retourneert. Beschikbare velden zijn onder meer:

Id, Naam, VoorNaam, MiddelsteNaam, MiddelsteInitiaal, LaatsteNaamTijdensGeboorte, LaatsteNaamHuidig, Bijnamen, LaatsteNaamAnder, EchteNaam, Voorvoegsel, Achtervoegsel
Geslacht, Geboortedatum, DatumOverlijden, GeboorteLocatie, OverlijdensLocatie, GeboorteDatumDecenium, OverlijdensDatumDecenium, Foto
Moeder, Vader, Ouders, Kinderen, Broers en Zussen, Echtgenoten
HeeftKinderen, GeenKinderen, Aangeraakt, IsLevend, Privacy, DataStatus
Afgeleide.VerkorteNaam, Verkorte.GeboorteNaamPrivé, Afgeleide.LangeNaamPrivé, Afgeleide.LangeNaam, Afgeleide.Geboorte.Naam
Manager

De GeboorteDatum en de OverlijdensDatum zijn JJJJ-MM-DD en kunnen nullen bevatten voor het jaar of de maand als de datum onvolledig is. De velden GeboorteDatumDecenium en OverlijdensDatumDecenium zijn strings zoals "1960's".

De velden Moeder en vader zijn de ID-waarden voor de ouders van het gevraagde profiel. Die kunnen worden gebruikt om meer profielgegevens op te halen met bijvoorbeeld een andere oproep om getPerson te krijgen. Als de waarde van het veld "Ouders" bevat, worden de profielgegevens voor de moeder en vader samen met het oorspronkelijke profiel geretourneerd. Evenzo kunt u de kinderen, broers en zussen en echtgenoten van een profiel opvragen. De velden die worden geretourneerd voor de profielen van deze extra familieleden zijn gelijk aan de velden die worden geretourneerd voor het gevraagde profiel.

Het HasChildren veld betekent dat het profiel kinderen heeft. Het veld NoChildren is het selectie vakje "geen kinderen meer" op de bewerk pagina.

Merk op dat niet alle velden beschikbaar zijn voor alle profielen. Toegang is afhankelijk van de instelling privacy en of de aangemelde gebruiker zich in de Vertrouwenslijst van het profiel bevindt.

Het gedrag met betrekking tot ontbrekende en privé gezinsleden voor alle API functies is als volgt:

  1. Als het startprofiel geen openbare stamboom heeft (privacyniveau < 35) en de gebruiker staat niet op de vertrouwenslijst, sluit dan de velden/

objecten voor familieleden volledig uit.

  1. Als het startprofiel een openbare stamboom heeft (niveau>=35) maar een familielid ontbreekt, retourneer dan een nulwaarde ("0").
  2. Als het familielid bestaat maar het familielid geen openbare stamboom heeft (<35) en de gebruiker staat niet op de vertrouwenslijst van het familielid, retourneer dan een waarde nul/leeg als nabestaande.

Als je "velden" leeg laat, bevatten de geretourneerde gegevens niet de nabestaanden.

Als je "*" gebruikt voor de parameter "velden", worden alle beschikbare gegevens geretourneerd (d.w.z. alle hierboven vermelde velden, inclusief de profielgegevens voor de familieleden).

getBio

De functie getBio haalt de biografie tekst op van een profiel voor één persoon.

key : dit is de Persoon.Naam (WikiTree ID) of de integer van het persoonsprofiel ID (Id).

De geretourneerde velden zijn:

pagina_naam (WikiTree ID), user_id, bio

getWatchlist

De functie getWatchlist retourneert profielen van de Watchlist van de ingelogde gebruiker en vereist daarom dat de gebruiker zich eerst aanmeldt. De geretourneerde lijst met profielen bevat velden die overeenkomen met die van getProfile.

getPerson : Indien ingesteld (1), worden Persoonsprofielen op de Watchlist geretourneerd. Als dit wordt doorgegeven als nul, worden Persoonsprofielen uitgesloten. De standaardinstelling (als u de parameter helemaal niet doorgeeft) is om Persoonsprofielen op te nemen.

getSpace : Indien ingesteld (1), worden de profielprofielen in de volglijst geretourneerd. Als dit wordt doorgegeven als nul, worden Space-profielen uitgesloten. De standaardinstelling (als je de parameter helemaal niet doorgeeft) is om ruimteprofielen op te nemen.

onlyLiving : Indien ingesteld (1), worden alleen persoonsprofielen van levende personen (degenen met IsLiving = true) geretourneerd.

excludeLiving : Indien ingesteld (1), worden Persoonsprofielen waarbij IsLiving = true wordt uitgesloten van de resultaten.

fields : De specifieke velden om te retourneren (zie getPerson).

limit : Beperking van het aantal geretourneerde profielen; de standaardinstelling is 100.

offset : Startwaarde van het eerste geretourneerde record; de standaardwaarde is 0.

order : Sorteervolgorde voor de profielen op de Watchlist. Waarde kan zijn user_id, user_name, user_last_name_current, user_birth_date, user_death_date, of page_touched. De standaard sorteervolgorde is op user_id (Person.Id).

getAncestors

key : De WikiTree-ID of Persoon.Id van het profiel waarvan de voorouders geretourneerd moeten worden.

depth : Hoeveel generaties wil je terug halen. De standaardwaarde is 5. Geldige waarden zijn 1-10.

getRelatives

keys : Een door komma's gescheiden lijst met WikiTree ID of Persoon.Id waarden voor de profielen waarvan familieleden moeten worden geretourneerd.

getParents : Indien juist, worden ouders voor elk persoonsprofiel geretourneerd.

getChildren : Als dit waar is, worden de Kinderen voor elk persoonsprofiel geretourneerd.

getSpouses : Als waar, dan woorden de echtgenoten van elk persoonsprofiel geretourneerd.

getSiblings : Als dit waar is, worden broers en zussen voor elk persoonsprofiel geretourneerd.

Voorbeelden & bronnen

Een demonstratie van het raamwerk van de API-functies is beschikbaar op: https://apps.wikitree.com/apps/api_demo.php

Een JavaScript-SDK met enkele hulpprogramma-functies voor het werken met API-aanroepen is beschikbaar op: https://github.com/wikitree/wikitree-javascript-sdk. Dit wordt gedemonstreerd op https://apps.wikitree.com/apps/casey1/wikitree-javascript-sdk.

Voor vragen over de nieuwste beschikbare acties en de bijbehorende syntaxis kunt u een e-mail sturen naar <WikiTreeApps@googlegroups.com>

Taal: en | nl
Vrijwaring: Dit is een niet-officiële vertaling. De Engelstalige versies zijn de officiële hulppagina's.
Vertaald: Margreet Beers


This page was last modified 15:10, 9 August 2018. This page has been accessed 240 times.