Wikidata:REST API/Authentication/nl
Overzicht
Hier is een kort overzicht van wat u moet weten om geverifieerd en geautoriseerd te worden bij het gebruik van de Wikibase REST API op Wikidata:
- Stel OAuth 2.0 in voor uw API-toegang op meta.wikimedia.org, wikimedia's centrale OAuth-service
- Uw nieuwe referenties (credentials) gebruiken om de API te gaan gebruiken
- Leer hoe u op de juiste manier kunt communiceren met de Wikibase REST API wanneer deze is geverifieerd
Voordat u begint
Dit document is geschreven met Wikidata in het achterhoofd. De basis-URL in alle voorbeelden is https://www.wikidata.org/w/rest.php/wikibase/v0. Als u uw eigen Wikibase gebruikt, hoeft u slechts https://wikidata.org te vervangen door de URL van uw eigen site.
Zie het hoofddocument van de REST API voor informatie over foutstatussen en limieten.
User agent
Verzoeken via de Wikibase REST API moeten een user agent bevatten volgens het user-agent beleid voor Wikimedia sites. Als uw aanvraag geen user agent heeft, ziet u de volgende fout:
{"code":"missing-user-agent","message":"Request must include User-Agent header","httpCode":400,"httpReason":"Bad Request"}
OAuth 2.0 instellen
Als u geverifieerde verzoeken wilt indienen via de Wikibase REST API voor Wikidata, moet u eerst een OAuth 2.0-client instellen (voorheen bekend als "consumer").
- Meld u aan bij meta.wikimedia.org met uw globale account.
- Een OAuth 2.0-client maken.
- (Kom er door te klikken op Speciale pagina's, dan Registratie van OAuth-toepassingen, vervolgens Dien een voorstel voor een nieuwe cliënt in.)
- Geef de volgende informatie op in het formulier:
- Naam toepassing: Noem het iets informatiefs. Voorbeeld: "Wikibase REST API for Wikidata"
- ''Toepassingsbeschrijving: Gebruik nogmaals een informatieve tekst die uitlegt hoe u de API wilt gebruiken. Voorbeeld: "Wikibase REST API access for maintaining my dataset about animal cookies"
- Deze cliënt is alleen bedoeld voor gebruik door (uw naam) (selectievakje): Vink dit vakje onder normale omstandigheden aan. Zie hieronder voor situaties waarin u dit vakje niet moet aanvinken.
- Toepasselijke types (selectievakjes): Vink elk vakje aan dat een soort toegang beschrijft die u nodig heeft voor uw taak.
- Door het indienen van deze aanvraag... (selectievakje): Lees de gebruikersovereenkomst en vink het vakje aan als u akkoord gaat met de voorwaarden.
- Dien het formulier in door op de knop "Consumer voorstellen" te klikken.
- Sla de drie tokens die op het volgende scherm gegeven worden, op:
- Client application key: gebruikt om tokens aan toonder te verkrijgen
- Client application secret: gebruikt om tokens aan toonder te verkrijgen
- Access token: biedt toegang tot de API wanneer deze is opgenomen in de API-aanvraag (lengte: ~1800 tekens)
Uw credentials gebruiken
Zodra u een toegangstoken heeft, kunt u onmiddellijk beginnen met het indienen van geverifieerde verzoeken aan de Wikibase REST API.
curl --request GET \
--url https://www.wikidata.org/w/rest.php/wikibase/v0/entities/items/Q42/statements \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer (your access token)'Niet-alleen-eigenaar cliënten
Als u ervoor kiest om een OAuth 2.0-client te maken die niet beperkt is tot uw eigen gebruik, moet u uw token aan toonder elke vier uur vernieuwen met behulp van uw clienttoepassings-id en clienttoepassingsgeheim:
curl --request POST \
--url https://www.wikidata.org/w/rest.php/oauth2/access_token \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data grant_type=client_credentials \
--data client_id=(your client id) \
--data client_secret=(your client secret)