REST API

Documentação da API para integrações B2B

Integre o Talktiko aos seus sistemas com nossa API REST. Gerencie conteúdo, acompanhe o progresso, receba webhooks, conecte seu LMS e provisione contas institucionais — tudo programaticamente.

Comece agora View OpenAPI Spec

Início rápido

Criar um token de API

Navegue até Configurações → Integrações → Tokens de API no painel de administração. Crie um token nomeado com as permissões que sua integração necessita.

# O token é exibido apenas uma vez na criação — copie e armazene com segurança

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

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

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

Autenticar requisições

Inclua o token como Bearer token no cabeçalho Authorization.

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

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

Processar respostas

Todos os endpoints retornam JSON. Recursos paginados incluem as chaves data, links e meta.

{

"data": [...],

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

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

}

Referência de endpoints

Autenticação

Gerencie tokens de API com permissões limitadas 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

Cursos e conteúdo

Navegue e gerencie cursos, aulas, treinos e exercícios.

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

Progresso do aluno

Acompanhe a atividade do aluno, conclusões e progresso 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

Receba notificações de eventos em tempo real com payloads assinados 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

Exportações de dados

Gere e baixe exportações CSV de forma assí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 (Integração LMS)

Início de sessão único para lançar cursos a partir do 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

Encaminhamento xAPI

Encaminhe a atividade de aprendizagem como declarações xAPI para seu 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

Instituições (B2B)

Gerencie contas institucionais, membros, faturamento, SSO e análises.

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

Segurança de webhooks

Cada entrega de webhook inclui um cabeçalho X-Signature-256 contendo um hash HMAC-SHA256 do corpo da requisição assinado com seu segredo de webhook.

# Verifique no seu manipulador de webhook

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

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

Payloads são reenviados até 3 vezes com backoff exponencial em caso de falha

Logs de entrega estão disponíveis via API e no painel de administração

Pings de teste verificam a conectividade do endpoint antes de se inscrever em eventos

Pronto para integrar?

Crie uma conta, gere um token de API e comece a construir sua integração em minutos. Planos Enterprise incluem suporte de integração dedicado.

Comece agora Planos empresariais