跳转到主要内容
Unlock your potential with 20% off all Premium Courses. Claim offer
Talktiko
REST API

API 文档 B2B 集成

通过 REST API 将 Talktiko 集成到您的系统中。管理内容、追踪进度、接收 Webhook、连接 LMS、配置机构账户——一切均可通过编程方式完成。

立即开始View OpenAPI Spec

快速入门

1

创建 API 令牌

在管理面板中导航至设置 → 集成 → API 令牌。创建具有集成所需权限的命名令牌。

# 令牌仅在创建时显示一次——请复制并安全保存
curl -X POST https://api.talktiko.com/api/auth/sign-in \
-H "Content-Type: application/json" \
-d '{"email":"…","password":"…"}'
2

验证请求

在 Authorization 标头中以 Bearer 令牌形式包含该令牌。

curl -H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/json" \
https://api.talktiko.com/api/courses
3

处理响应

所有端点返回 JSON。分页资源包含 data、links 和 meta 键。

{
"data": [...],
"links": { "next": "...?page=2" },
"meta": { "total": 42, "per_page": 15 }
}

端点参考

认证

通过 Laravel Sanctum 管理具有作用域权限的 API 令牌。

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

课程与内容

浏览和管理课程、课时、训练和训练项目。

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

学习者进度

追踪学习者活动、完成情况和 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

Webhook

通过 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

数据导出

异步生成和下载 CSV 导出。

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 集成）

从 Canvas、Blackboard 和 Moodle 进行单点登录课程启动。

GET
/api/integrations/lti-consumers

List LTI consumer registrations

POST
/api/integrations/lti-consumers

Register an LTI consumer

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 转发

将学习活动作为 xAPI 声明转发到 Learning Record Store。

GET
/api/integrations/xapi-endpoints

List xAPI endpoint configurations

POST
/api/integrations/xapi-endpoints

Register an xAPI LRS endpoint

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

Update endpoint credentials

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

Remove an xAPI endpoint

机构 (B2B)

管理机构账户、成员、账单、SSO 和分析。

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 安全

每次 Webhook 投递都包含一个 X-Signature-256 标头，其中包含使用您的 Webhook 密钥对请求正文进行 HMAC-SHA256 哈希签名的结果。

# 在您的 Webhook 处理程序中进行验证
$signature = hash_hmac('sha256', $requestBody, $webhookSecret);
$isValid = hash_equals($signature, $headerSignature);

失败时有效载荷将以指数退避方式最多重试 3 次

投递日志可通过 API 和管理面板查看

测试 ping 可在订阅事件前验证端点连通性

准备好集成了吗？

创建账户，生成 API 令牌，几分钟内即可开始构建集成。Enterprise 计划包含专属集成支持。

立即开始商业计划