REST API

Documentazione API per integrazioni B2B

Integra Talktiko nei tuoi sistemi con la nostra API REST. Gestisci i contenuti, monitora i progressi, ricevi webhooks, collega il tuo LMS e provvedi agli account istituzionali — il tutto in modo programmatico.

Inizia ora View OpenAPI Spec

Guida rapida

Crea un token API

Vai su Impostazioni → Integrazioni → Token API nella dashboard di amministrazione. Crea un token con nome con le autorizzazioni necessarie per la tua integrazione.

# Il token viene mostrato solo una volta alla creazione — copialo e conservalo in modo sicuro

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

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

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

Autentica le richieste

Includi il token come Bearer token nell'header Authorization.

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

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

Gestisci le risposte

Tutti gli endpoint restituiscono JSON. Le risorse paginate includono le chiavi data, links e meta.

{

"data": [...],

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

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

}

Riferimento degli endpoint

Autenticazione

Gestisci i token API con autorizzazioni limitate tramite 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

Corsi e contenuti

Esplora e gestisci corsi, lezioni, allenamenti ed esercizi.

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

Progressi degli studenti

Monitora l'attività degli studenti, i completamenti e i progressi 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

Ricevi notifiche di eventi in tempo reale con payload firmati 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

Esportazioni dati

Genera e scarica esportazioni CSV in modo asincrono.

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 (Integrazione LMS)

Avvio corsi con Single Sign-On da Canvas, Blackboard e 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

Inoltro xAPI

Inoltra l'attività di apprendimento come statement xAPI al tuo 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

Istituzioni (B2B)

Gestisci account istituzionali, membri, fatturazione, SSO e analisi.

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

Sicurezza dei webhook

Ogni consegna di webhook include un header X-Signature-256 contenente un hash HMAC-SHA256 del corpo della richiesta firmato con il tuo segreto webhook.

# Verifica nel tuo gestore webhook

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

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

I payload vengono riprovati fino a 3 volte con backoff esponenziale in caso di errore

I log di consegna sono disponibili tramite API e nella dashboard di amministrazione

I ping di test verificano la connettività dell'endpoint prima della sottoscrizione agli eventi

Pronto per l'integrazione?

Crea un account, genera un token API e inizia a costruire la tua integrazione in pochi minuti. I piani Enterprise includono supporto di integrazione dedicato.

Inizia ora Piani aziendali