API-toegang tot TOPdesk
API-functionaliteiten en vereisten
TOPdesk wordt geleverd met een application programming interface (API). Met deze API kun je TOPdesk integreren met andere systemen. Je kunt bijvoorbeeld een widget toevoegen aan je intranet die de huidige meldingen of reserveringen van je gebruikers toont, of een koppeling aanmaken met je controlesysteem zodat gebruikers direct meldingen kunnen aanmaken in TOPdesk.
Opmerking
Je hebt toegang tot de API via https://[TOPdeskURL]/tas/api/.
Welke processen worden ondersteund door de API?
De ondersteuning voor deze API verschilt per proces. Wij breiden continu het aantal ondersteunde processen uit. Voor alle beschikbare API's, zie onze TOPdesk API documentatie pagina.
Niet voor beginners: doelgroep voor de API-handleiding.
In de API-handleiding lopen we door de stappen die nodig zijn om toegang te krijgen tot de TOPdesk API en om hiermee gegevens uit TOPdesk te halen. De gebruikte technieken worden echter niet uitgelegd: HTTP, REST en JSON. Om deze handleiding te begrijpen en te gebruiken, moet je bekend zijn met het gegevensmodel van TOPdesk en de opmaak van JSON-gegevens.
Voorwaarden voor toegang tot de API
Voordat je naar de API gaat, moet je eerst:
Activeer TOPdesk-authenticatie en/of LDAP-authenticatie in het Behandelaarsgedeelte van de TOPdesk-omgeving.
Maak een gebruiker aan die de API zal aanroepen. Wij raden aan om een apart behandelaars- of persoonsaccount aan te maken voor iedere applicatie die toegang nodig heeft tot de API. Zo wordt het oplossen van problemen eenvoudiger. Of je een behandelaars- of persoonsaccount nodig hebt, hangt af van het domein (Behandelaarsgedeelte of Selfserviceportal) waartoe je toegang wilt hebben. Stel ook TOPdesk- en/of LDAP-aanmeldingsgegevens in voor de gebruiker.
Maak een rechtengroep aan die de API kan gebruiken. Wijs leesrechten toe voor REST API, en schrijfrechten voor Applicatiewachtwoorden gebruiken (in het blok API-toegang machtigingen).
Koppel de API-gebruiker(s) aan deze API-rechtengroep en aan andere rechtengroepen die nodig zijn om toegang te krijgen tot de gewenste modules van TOPdesk.
Installeer een tool om HTTP-requests aan te maken en testen. In deze handleiding zie je voorbeelden met de Talend API Tester Chrome extensie (voorheen bekend als Restlet Client). Sommige instructies zijn specifiek van toepassing op dit hulpprogramma. Je kunt echter ook gebruikmaken van een ander hulpprogramma. De meeste hulpprogramma's werken op vergelijkbare wijze.
De Talend API Tester-extensie verschijnt als een pictogram van een paars polygoon in de browser. Klik op het pictogram om de add-on te openen.