דלג לתוכן הראשי
קבלו 20% הנחה על כל קורסי הפרימיום. קבלו את ההטבה
Talktiko
REST API

תיעוד API עבור אינטגרציות B2B

שלב את Talktiko במערכות שלך באמצעות REST API. נהל תוכן, עקוב אחר התקדמות, קבל webhooks, התחבר ל-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

אמת בקשות

כלול את הטוקן כ-Bearer token בכותרת Authorization.

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 }
}

מפרט נקודות קצה

אימות

נהל טוקני 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

Webhooks

קבל התראות אירועים בזמן אמת עם מטענים חתומים.

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 ל-LRS שלך.

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

אבטחת Webhooks

כל משלוח webhook כולל כותרת X-Signature-256 עם hash HMAC-SHA256 של גוף הבקשה חתום עם הסוד שלך.

# אמת בטיפול ה-webhook שלך
$signature = hash_hmac('sha256', $requestBody, $webhookSecret);
$isValid = hash_equals($signature, $headerSignature);

מטענים נשלחים שוב עד 3 פעמים עם backoff מעריכי בכישלון

יומני משלוח זמינים דרך API ובלוח הניהול

פינגים בדיקתיים מאמתים קישוריות לפני הרשמה לאירועים

מוכן לשלב?

צור חשבון, צור טוקן API והתחל לבנות את האינטגרציה שלך תוך דקות. תוכניות Enterprise כוללות תמיכת אינטגרציה ייעודית.

התחלתוכניות עסקיות