REST API

API-documentatie voor B2B-integraties

Integreer Talktiko in uw systemen met onze REST API. Beheer content, volg voortgang, ontvang webhooks, koppel uw LMS en provisioneer institutionele accounts — allemaal programmatisch.

Aan de slag View OpenAPI Spec

Snel starten

API-token aanmaken

Ga naar Instellingen → Integraties → API-tokens in het admin-dashboard. Maak een benoemd token aan met de bevoegdheden die uw integratie nodig heeft.

# Token wordt slechts één keer getoond bij aanmaak — kopieer en bewaar het veilig

curl -X POST https://api.talktiko.com/api/auth/sign-in \

-H "Content-Type: application/json" \

-d '{"email":"…","password":"…"}'

Verzoeken authenticeren

Voeg het token toe als Bearer token in de Authorization-header.

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

https://api.talktiko.com/api/courses

Antwoorden verwerken

Alle endpoints retourneren JSON. Gepagineerde bronnen bevatten data-, links- en meta-sleutels.

{

"data": [...],

"links": { "next": "...?page=2" },

"meta": { "total": 42, "per_page": 15 }

}

Endpoint-referentie

Authenticatie

Beheer API-tokens met beperkte bevoegdheden via Laravel Sanctum.

POST

/api/auth/sign-in

Authenticate and receive a bearer token

GET

/api/auth/me

Get the authenticated user profile

GET

/api/integrations/tokens

List all API tokens

POST

/api/integrations/tokens

Create a scoped API token with named abilities

DELETE

/api/integrations/tokens/{token}

Revoke an API token

Cursussen en content

Blader door en beheer cursussen, lessen, trainingen en oefeningen.

GET

/api/public/courses

List all published courses (no auth required)

GET

/api/public/courses/{slug}

Get course details by slug (no auth required)

GET

/api/courses

List courses with filtering and pagination

GET

/api/courses/{id}

Get full course details

GET

/api/lessons

List lessons with optional course filter

GET

/api/trainings

List training blocks

GET

/api/trainingItems

List training items with type filtering

Leervoortgang

Volg leeractiviteit, afronding en CEFR-voortgang.

GET

/api/stats

Platform-wide statistics

GET

/api/courses/{course}/lesson-progress

Per-lesson progress for a course

GET

/api/progress-history

Historical progress data

GET

/api/cefr/report

CEFR skill-level report for authenticated user

GET

/api/learning-insights

Personalized learning analytics

GET

/api/gamification/stats

Streaks, XP, and achievement data

GET

/api/gamification/leaderboard

Platform leaderboard

Webhooks

Ontvang realtime gebeurtenismeldingen met HMAC-SHA256-ondertekende payloads.

GET

/api/integrations/webhooks

List configured webhooks

POST

/api/integrations/webhooks

Create a webhook with event subscriptions

PUT

/api/integrations/webhooks/{id}

Update webhook URL or events

DELETE

/api/integrations/webhooks/{id}

Delete a webhook

POST

/api/integrations/webhooks/{id}/test

Send a test ping

GET

/api/integrations/webhooks/{id}/deliveries

View delivery history and status

Data-exports

Genereer en download CSV-exports asynchroon.

GET

/api/integrations/exports

List export jobs and their status

POST

/api/integrations/exports

Request a new data export (learner progress, completions, activity)

GET

/api/integrations/exports/{id}

Check export status

GET

/api/integrations/exports/{id}/download

Download completed CSV export

LTI 1.3 (LMS-integratie)

Single Sign-On cursusstart vanuit Canvas, Blackboard en Moodle.

GET

/api/integrations/lti-consumers

List LTI consumer registrations

POST

/api/integrations/lti-consumers

GET

/api/lti/login

OIDC login initiation endpoint

POST

/api/lti/callback

LTI launch callback

POST

/api/lti/grade-passback/{launch}

Push grade back to LMS

xAPI-doorsturen

Stuur leeractiviteit als xAPI-statements door naar uw Learning Record Store.

GET

/api/integrations/xapi-endpoints

List xAPI endpoint configurations

POST

/api/integrations/xapi-endpoints

PUT

/api/integrations/xapi-endpoints/{id}

Update endpoint credentials

DELETE

/api/integrations/xapi-endpoints/{id}

Remove an xAPI endpoint

Instellingen (B2B)

Beheer institutionele accounts, leden, facturering, SSO en analyses.

GET

/api/institutions

List institutions

POST

/api/institutions

Create an institution

GET

/api/institutions/{id}/members

List institution members

POST

/api/institutions/{id}/members/bulk

Bulk provision members via CSV

GET

/api/institutions/{id}/analytics

White-label analytics dashboard data

GET

/api/institutions/{id}/sso

SSO configuration (SAML/OIDC)

PUT

/api/institutions/{id}/sso

Update SSO settings

GET

/api/institutions/{id}/compliance

Compliance documentation status

Billing & Subscriptions

Manage checkout sessions, subscriptions, and billing portal.

GET

/api/subscription-plans

List available subscription plans

POST

/api/billing/checkout-session

Create a Stripe checkout session

POST

/api/billing/portal-session

Create a billing portal session

POST

/api/billing/apply-promo

Validate and apply a promo code

GET

/api/trial/status

Check free trial status

SDKs & Tools

Libraries and tools to accelerate your integration.

JavaScript SDK

@talktiko/js

Type-safe client for Node.js and browser environments.

Python SDK

talktiko-python

Full-featured Python client with async support.

REST Client

Postman / Insomnia

Import the OpenAPI JSON into your API client for instant requests and environment setup.

CLI

curl / HTTPie

Use the YAML spec and Quick Start examples for terminal-based integrations.

Rate Limiting

API requests are rate-limited per token to ensure fair usage and platform stability.

Exceeded requests return HTTP 429 with a Retry-After header.

Free

100

requests / min

Pro

1,000

requests / min

Enterprise

Custom

requests / min

Webhook-beveiliging

Elke webhookbezorging bevat een X-Signature-256-header met een HMAC-SHA256-hash van de verzoekbody, ondertekend met uw webhookgeheim.

# Verifieer in uw webhookhandler

$signature = hash_hmac('sha256', $requestBody, $webhookSecret);

$isValid = hash_equals($signature, $headerSignature);

Payloads worden bij falen tot 3 keer opnieuw geprobeerd met exponentiële backoff

Bezorgingslogboeken zijn beschikbaar via de API en in het admin-dashboard

Testpings verifiëren endpointconnectiviteit voordat u zich abonneert op gebeurtenissen

Klaar om te integreren?

Maak een account aan, genereer een API-token en begin binnen enkele minuten met het bouwen van uw integratie. Enterprise-plannen bevatten toegewijde integratieondersteuning.

Aan de slag Zakelijke plannen