REST API

Documentation API pour les intégrations B2B

Intégrez Talktiko dans vos systèmes avec notre API REST. Gérez le contenu, suivez les progrès, recevez des webhooks, connectez votre LMS et provisionnez des comptes institutionnels — le tout par programmation.

Commencer View OpenAPI Spec

Démarrage rapide

Créer un token API

Accédez à Paramètres → Intégrations → Tokens API dans le tableau de bord administrateur. Créez un token nommé avec les permissions nécessaires à votre intégration.

# Le token n'est affiché qu'une seule fois à la création — copiez-le et conservez-le en lieu sûr

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

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

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

Authentifier les requêtes

Incluez le token comme Bearer token dans l'en-tête Authorization.

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

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

Traiter les réponses

Tous les endpoints retournent du JSON. Les ressources paginées incluent les clés data, links et meta.

{

"data": [...],

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

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

}

Référence des endpoints

Authentification

Gérez les tokens API avec des permissions scopées 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

Cours et contenu

Parcourez et gérez les cours, leçons, entraînements et exercices.

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

Progrès des apprenants

Suivez l'activité des apprenants, les achèvements et la progression CEFR.

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

Recevez des notifications d'événements en temps réel avec des payloads signés HMAC-SHA256.

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

Exports de données

Générez et téléchargez des exports CSV de manière asynchrone.

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 (Intégration LMS)

Lancement de cours en Single Sign-On depuis Canvas, Blackboard et 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

Transfert xAPI

Transférez l'activité d'apprentissage sous forme de déclarations xAPI vers votre 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

Institutions (B2B)

Gérez les comptes institutionnels, les membres, la facturation, le SSO et les 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

Sécurité des webhooks

Chaque livraison de webhook inclut un en-tête X-Signature-256 contenant un hash HMAC-SHA256 du corps de la requête signé avec votre secret webhook.

# Vérifiez dans votre gestionnaire de webhook

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

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

Les payloads sont retentés jusqu'à 3 fois avec backoff exponentiel en cas d'échec

Les journaux de livraison sont disponibles via l'API et dans le tableau de bord administrateur

Les pings de test vérifient la connectivité de l'endpoint avant de s'abonner aux événements

Prêt à intégrer ?

Créez un compte, générez un token API et commencez à construire votre intégration en quelques minutes. Les plans Enterprise incluent un support d'intégration dédié.

Commencer Plans entreprise