REST API

توثيق API لـ تكامل B2B

ادمج Talktiko في أنظمتك عبر REST API. أدِر المحتوى وتتبّع التقدّم واستقبل Webhook واتصل بنظام إدارة التعلّم وأعدّ الحسابات المؤسسية — كل ذلك برمجياً.

ابدأ الآن View OpenAPI Spec

البدء السريع

أنشئ رمز API

انتقل إلى الإعدادات ← التكاملات ← رموز API في لوحة التحكم. أنشئ رمزاً مسمّى بالصلاحيات التي يحتاجها تكاملك.

# يُعرض الرمز مرة واحدة فقط عند الإنشاء — انسخه واحفظه بأمان

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

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

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

مصادقة الطلبات

أدرج الرمز كرمز Bearer في ترويسة Authorization.

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 }

}

مرجع نقاط النهاية

المصادقة

أدِر رموز API بصلاحيات محددة النطاق عبر 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

الدورات والمحتوى

تصفّح وأدِر الدورات والدروس والتدريبات وعناصر التدريب.

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

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 ترويسة X-Signature-256 تحتوي على تجزئة HMAC-SHA256 لجسم الطلب موقّعة بمفتاح Webhook السرّي الخاص بك.

# تحقّق في معالج Webhook الخاص بك

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

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

تُعاد محاولة إرسال الحمولات حتى 3 مرات بتراجع أسّي عند الفشل

سجلات التسليم متاحة عبر API وفي لوحة التحكم

اختبار الاتصال يتحقّق من اتصال نقطة النهاية قبل الاشتراك في الأحداث

هل أنت مستعد للتكامل؟

أنشئ حساباً وأنشئ رمز API وابدأ ببناء تكاملك في دقائق. تتضمّن خطط Enterprise دعماً مخصصاً للتكامل.

ابدأ الآن خطط الأعمال