Inhoudsopgave

De Xanti API voor ontwikkelaars

Wil je een eigen programma of import aan je website koppelen? Alles wat je in het beheer met items doet, kan een programma ook via de Xanti API. Deze pagina is voor ontwikkelaars.

Zo begin je

  1. Vraag Telartis om een gebruiker in de groep API met een API-beleid. Neem voor een automatische koppeling een aparte gebruiker, bijvoorbeeld Importtaak, met alleen de rechten en folders die nodig zijn.
  2. Maak voor die gebruiker een API-token (zie Een API-token maken en intrekken).
  3. Open de beschrijving van de API op je eigen website: https://www.example.nl/api/openapi. Dit is een OpenAPI 3.1-beschrijving van alle endpoints, met hun parameters. Je hebt er geen token voor nodig.
  4. Test het token met het endpoint whoami:
curl -H "Authorization: Bearer xt_..." https://www.example.nl/api/whoami

Je krijgt de gebruiker, de rechten en de endpoints terug die dit token mag gebruiken.

Goed om te weten

  • De API werkt alleen via https. Lezen gaat met GET, schrijven met POST en een JSON-body.
  • Elk antwoord is JSON met error, message en result. Bij een fout staat er ook een code, zoals not_found of forbidden. Controleer error en code, niet de tekst van message: die is in de taal van de website.
  • Het programma werkt met de rechten van de gebruiker van het token, binnen de Bevoegdheden van het token en het API-beleid.
  • Een verwijderd item gaat naar de prullenbak. Met item_restore zet je het terug.
  • Stuur bij item_update de waarde modified mee die je hebt gelezen. Heeft iemand anders het item intussen gewijzigd, dan wordt er niets opgeslagen.
  • Elke aanroep staat onder Statistieken > API.

Gebruik je de oude exportfuncties export_query, export_obj of export_answer nog met een gedeelde sleutel? Die werken ook met een API-token met read. Daarvoor moet de gebruiker ook webmaster zijn. Deze exports staan niet in /api/openapi.

Een AI-assistent koppelen via MCP? Zie Een AI-assistent koppelen. Het MCP-adres is /api/mcp.

Zie ook

  • Een API-token maken en intrekken
  • Een AI-assistent koppelen
  • Veilig werken met een AI-assistent

Gecontroleerd: november 2026