REST API

Documentación API para integraciones B2B

Integre Talktiko en sus sistemas con nuestra API REST. Gestione contenido, rastree el progreso, reciba webhooks, conecte su LMS y aprovisione cuentas institucionales — todo de forma programática.

Comenzar View OpenAPI Spec

Inicio rápido

Crear un token API

Vaya a Configuración → Integraciones → Tokens API en el panel de administración. Cree un token con nombre con las capacidades que su integración necesita.

# El token se muestra solo una vez al crearlo — cópielo y guárdelo de forma segura

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

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

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

Autenticar solicitudes

Incluya el token como Bearer token en el encabezado Authorization.

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

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

Manejar respuestas

Todos los endpoints devuelven JSON. Los recursos paginados incluyen las claves data, links y meta.

{

"data": [...],

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

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

}

Referencia de endpoints

Autenticación

Gestione tokens API con capacidades limitadas a través de 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

Cursos y contenido

Explore y gestione cursos, lecciones, entrenamientos y ejercicios.

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

Progreso del estudiante

Rastree la actividad del estudiante, finalizaciones y progreso 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

Reciba notificaciones de eventos en tiempo real con payloads firmados 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

Exportaciones de datos

Genere y descargue exportaciones CSV de forma asíncrona.

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 (Integración LMS)

Inicio de sesión único para lanzar cursos desde Canvas, Blackboard y 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

Reenvío xAPI

Reenvíe la actividad de aprendizaje como declaraciones xAPI a su 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

Instituciones (B2B)

Gestione cuentas institucionales, miembros, facturación, SSO y análisis.

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

Seguridad de webhooks

Cada entrega de webhook incluye un encabezado X-Signature-256 que contiene un hash HMAC-SHA256 del cuerpo de la solicitud firmado con su secreto de webhook.

# Verifique en su manejador de webhook

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

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

Los payloads se reintentan hasta 3 veces con backoff exponencial en caso de fallo

Los registros de entrega están disponibles a través de la API y en el panel de administración

Los pings de prueba verifican la conectividad del endpoint antes de suscribirse a eventos

¿Listo para integrar?

Cree una cuenta, genere un token API y comience a construir su integración en minutos. Los planes Enterprise incluyen soporte de integración dedicado.

Comenzar Planes empresariales