Met de Simpele tekst API maakt je eigen systeem automatisch een Simpele tekst van een pagina: een korte beschrijving in eenvoudige taal, met de belangrijkste punten op een rij. Je stuurt de tekst van een pagina naar Tolkie en krijgt de Simpele tekst terug, die je zelf op je website laat zien. Stuur je dezelfde tekst opnieuw, dan krijg je de eerder gemaakte Simpele tekst terug. Is de tekst veranderd, dan maakt de API een nieuwe.
Wat doet de Simpele tekst API?
De API maakt van een of meer tekstblokken een korte samenvatting in eenvoudige taal. Je krijgt een korte beschrijving en een paar samenvattende punten terug. Zo kunnen bezoekers die moeite hebben met lezen snel zien waar een nieuwsartikel of lange pagina over gaat. De Simpele tekst wordt per pagina en per taal opgeslagen.
Wat is het verschil met de Text Simplification API?
Simpele tekst API | Text Simplification API | |
Wat krijg je terug? | Een korte samenvatting: een beschrijving en een paar kernpunten | Het hele artikel, herschreven naar taalniveau A2, met titel, inleiding en alinea's met tussenkoppen |
Wanneer gebruik je het? | Als lezers snel willen weten waar een pagina over gaat | Als lezers het hele artikel in eenvoudige taal willen lezen |
Wat gebeurt er als ik dezelfde tekst opnieuw instuur?
Tolkie slaat elke Simpele tekst op per organisatie, pagina en taal. Stuur je voor dezelfde pagina dezelfde tekst opnieuw, dan krijg je de Simpele tekst terug die eerder is gemaakt. Heb je de tekst aangepast, dan maakt de API automatisch een nieuwe Simpele tekst. Je hoeft dus niet zelf bij te houden of er al een Simpele tekst bestaat.
Kan ik een Simpele tekst uit de API aanpassen in Mijn Tolkie?
Nee. Simpele teksten die via de Simpele tekst API zijn gemaakt, kun je niet aanpassen in Mijn Tolkie. Het artikel Hoe kan ik een Simpele tekst aanpassen via Mijn Tolkie? gaat over Simpele teksten in Tolkie Leeshulp, niet over teksten uit de API. Heb je hier vragen over? Mail dan naar [email protected].
Wie toont de Simpele tekst aan de lezer?
Dat doen jullie zelf. Tolkie levert alleen de tekst, niet de knoppen of de vormgeving. Je bepaalt dus zelf waar en hoe de Simpele tekst op je website verschijnt. De koppeling bouwt jullie eigen developmentteam of webbouwer. Tolkie denkt mee en beantwoordt vragen.
Hoe krijg ik toegang tot de API?
Voor de API heb je een token nodig. Dat krijg je tijdens de implementatie van je contactpersoon bij Tolkie of van support. Wil je de API gaan gebruiken? Neem dan contact met ons op via de contactpagina.
Hoe werkt de API technisch?
Dit deel is bedoeld voor developers. Je roept de API rechtstreeks aan vanuit je eigen systeem. Met dit endpoint kun je:
een of meer tekstblokken aanleveren;
automatisch een Simpele tekst laten maken;
de Simpele tekst per pagina en per taal laten opslaan en weer ophalen.
Hoe authenticeer je een aanvraag?
Het endpoint gebruikt authenticatie met een token. Stel deze header in:
Authorization: Token {jouw_token}Een Origin-header is niet nodig.
Hoe ziet de aanvraag eruit?
Endpoint:
POST https://api.tolkie.nl/api/v1/tolkie/summarize-external
Body:
{
"text_list": [
{ "id": 1, "text": "string" },
{ "id": 2, "text": "string" }
],
"url_field": "https://example.com/news/123",
"content_lang": "nl"
}
Uitleg van de velden
Veld | Verplicht | Beschrijving |
| Ja | Een lijst met tekstfragmenten die samen worden samengevat. De totale lengte is minimaal 150 tekens. |
| Ja | De volledige URL van de pagina waar de tekst op staat. Hiermee wordt de Simpele tekst per pagina opgeslagen. |
| Nee | De taalcode van de inhoud, bijvoorbeeld |
Wat krijg je terug?
Is er een Simpele tekst beschikbaar, dan ziet het antwoord er zo uit:
{
"description": "Korte beschrijving van het artikel.",
"summaryLines": [
{ "text": "Belangrijk punt 1." },
{ "text": "Belangrijk punt 2." }
]
}Kan er geen Simpele tekst worden gemaakt, dan geeft de API een leeg object terug:
{}
Hoe werken opslag en caching?
Simpele teksten worden opgeslagen per organisatie, pad en taal.
Blijft de aangeleverde tekst hetzelfde, dan geeft de API de Simpele tekst terug die eerder is gemaakt.
Verandert de tekst, dan maakt de API automatisch een nieuwe Simpele tekst.
Welke foutmeldingen kun je krijgen?
Status | Betekenis |
400 | Ongeldige velden of te weinig tekst (minder dan 150 tekens) |
401 | Het token ontbreekt of is ongeldig |
403 | Simpele teksten staan uit voor jullie account. Neem contact op met support als je ze wilt gebruiken. |
200 met | Er kon geen Simpele tekst worden gemaakt |
Waar kan ik terecht met vragen?
Heb je vragen over de koppeling of krijg je een foutmelding? Mail naar [email protected]. Wil je de API gaan gebruiken? Neem dan contact op via de contactpagina.