Voor een Tolkie API heb je een token nodig. Neem daarvoor contact met ons op via de contactpagina. Je ontvangt het token van je contactpersoon bij Tolkie of van support, tijdens de implementatie. Je systeem stuurt het token daarna mee bij elke aanvraag aan de API.
Hoe vraag ik toegang aan?
Vertel wat je wilt koppelen. Beschrijf kort je systeem, je doelgroep en wat je met de API wilt doen. Dat kan via de contactpagina.
We kiezen samen de beste route. We kijken of een bestaande API past of dat een API op maat logischer is.
We maken afspraken. Bijvoorbeeld over wat je terugkrijgt, hoeveel teksten je verwerkt, veiligheid en de manier van koppelen.
Je ontvangt het token. Dat krijg je tijdens de implementatie van je contactpersoon bij Tolkie of van support.
Je team bouwt de koppeling. Je eigen developers of je webbouwer verwerken de API in je systeem. Tolkie denkt mee en beantwoordt vragen.
Gebruik je meer dan één API? Vertel dat bij je aanvraag. Dan regelen we de toegang voor alle API's die je nodig hebt.
Hoe gebruik ik het token?
Je systeem stuurt het token mee in de header van elke aanvraag, zo:
Authorization: Token jouw-token
Content-Type: application/json
Ontbreekt het token, of klopt het niet? Dan geeft de API de foutcode 401. Meer over foutcodes lees je in De API geeft een foutmelding. Wat kan ik doen?.
Moet ik mijn domein laten registreren?
Alleen bij de Translation API. Die controleert of een aanvraag komt van een domein dat bij Tolkie bekend is voor jouw organisatie. Daarvoor kijkt de API naar de Origin-header en naar het veld url_field, de volledige URL van de pagina die je vertaalt. Klopt het domein niet, dan krijg je de foutcode 403.
Bij de Text Simplification API en de Simpele tekst API speelt dit niet. Daar is het token genoeg.
Wil je de Translation API gebruiken vanaf een domein dat nog niet bij ons bekend is? Mail dan [email protected] met de domeinen waarvandaan je de API wilt gebruiken.
Wie in onze organisatie beheert het token?
Dat bepaal je zelf. Meestal ligt het token bij de developers of de webbouwer die de koppeling maken, of bij je ICT-afdeling. Een paar tips:
Behandel het token als een wachtwoord. Deel het alleen met de mensen die de koppeling bouwen of beheren.
Zet het token niet in een openbaar document, een gedeelde map of een openbare codeopslag.
Stuur het token nooit mee in een e-mail aan support. Dat is ook niet nodig om je te helpen.
Leg vast wie het token beheert, zodat de koppeling blijft werken als iemand vertrekt.
Wat doe ik als het token is uitgelekt?
Denk je dat het token in verkeerde handen is gekomen? Mail dan meteen [email protected]. Dan kijken we samen wat er nodig is.
Waar vind ik de technische documentatie?
Heb je nog vragen over toegang tot een API? Neem contact op via de contactpagina of mail [email protected].