مشخصات API

مشخصات API پلتفرم Vivid Visual

اصول API

سبک REST با نسخه‌بندی /api/v1. احراز هویت Bearer Token از Keycloak. خطاها با ساختار یکنواخت: code، message، traceId.

نمونه Endpoint های Learning

• GET /api/v1/courses?category=architecture&page=1
• GET /api/v1/courses/{courseId}
• POST /api/v1/courses/{courseId}/enroll
• GET /api/v1/learning-paths/{pathId}
• POST /api/v1/lessons/{lessonId}/progress

نمونه Endpoint های Player

• GET /api/v1/player/sessions/{lessonId}/resume
• POST /api/v1/player/bookmarks
• POST /api/v1/player/notes
• POST /api/v1/player/upsell-events

نمونه Endpoint های Marketplace و Commerce

• GET /api/v1/marketplace/products?type=3d-model
• POST /api/v1/cart/items
• POST /api/v1/orders/checkout
• GET /api/v1/subscriptions/current
• POST /api/v1/licenses/validate

نمونه Endpoint های CRM

• POST /api/v1/crm/leads
• PATCH /api/v1/crm/leads/{leadId}/stage
• POST /api/v1/crm/opportunities
• POST /api/v1/crm/activities

نمونه Endpoint های Talent

• POST /api/v1/jobs
• GET /api/v1/jobs/{jobId}/applications
• POST /api/v1/jobs/{jobId}/apply
• POST /api/v1/resumes/export-pdf

نمونه Endpoint های HR و PM

• POST /api/v1/hr/attendance/check-in
• POST /api/v1/hr/leave-requests
• POST /api/v1/pm/projects
• PATCH /api/v1/pm/tasks/{taskId}/status

Endpoint گزارش

• GET /api/v1/reports/revenue?from=2026-01-01&to=2026-01-31
• GET /api/v1/reports/learning-completion
• GET /api/v1/reports/crm-pipeline