REST API

APIドキュメント B2Bインテグレーション

REST APIでTalktikoをお客様のシステムに統合しましょう。コンテンツ管理、進捗追跡、Webhook受信、LMS接続、機関アカウントのプロビジョニング — すべてプログラムで操作可能です。

始める View OpenAPI Spec

クイックスタート

APIトークンを作成

管理ダッシュボードの設定 → インテグレーション → APIトークンに移動します。インテグレーションに必要なアビリティを持つ名前付きトークンを作成してください。

# トークンは作成時に一度だけ表示されます — コピーして安全に保管してください

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

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

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

リクエストの認証

AuthorizationヘッダーにBearerトークンとしてトークンを含めてください。

curl -H "Authorization: Bearer YOUR_TOKEN" \

-H "Accept: application/json" \

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

レスポンスの処理

すべてのエンドポイントは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からのシングルサインオンによるコースLaunch。

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

xAPI転送

学習アクティビティをxAPIステートメントとして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

機関（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配信には、Webhookシークレットで署名されたリクエストボディのHMAC-SHA256ハッシュを含むX-Signature-256ヘッダーが含まれます。

# Webhookハンドラーで検証してください

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

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

ペイロードは失敗時に指数バックオフで最大3回リトライされます

配信ログはAPIおよび管理ダッシュボードで利用可能です

テストpingはイベントのサブスクライブ前にエンドポイントの接続性を確認します

インテグレーションの準備はできていますか？

アカウントを作成し、APIトークンを生成して、数分でインテグレーションの構築を開始しましょう。エンタープライズプランには専用のインテグレーションサポートが含まれます。

始めるビジネスプラン