تخطي إلى المحتوى
ڤيريون
الأسعار تسجيل الدخول

مرجع واجهة API

نقاط REST الرئيسية مجمّعة حسب المجال.

نمط حزمة API النشطة: rest
ما لم يُذكر خلاف ذلك، المسارات المحمية تتطلب رمز Bearer من Sanctum.

مواصفات OpenAPI

عقد قابل للقراءة آليًا لمسارات API الرئيسية.

Authentication & Identity

Register, login, and manage user profiles.

POST /api/identity/register Create a new user account.
POST /api/identity/login Authenticate and receive an API token.
POST /api/identity/logout Revoke the current API token.
GET /api/identity/profile Fetch the authenticated user profile.
PUT /api/identity/profile Update profile fields and preferences.
POST /api/identity/profile/publish Publish a public profile slug.
GET /api/identity/u/{slug} Fetch a public profile by slug.

Resumes

تركيز الحزمة

Build, version, and publish resume documents.

GET /api/resumes List resumes for the authenticated user.
POST /api/resumes Create a resume with default sections.
GET /api/resumes/{resume} Fetch a resume with sections and blocks.
PUT /api/resumes/{resume} Update resume metadata.
POST /api/resumes/{resume}/publish Publish a resume and snapshot a version.
POST /api/resumes/{resume}/sections Add a section to a resume.
GET /api/resumes/{resume}/download Download the resume as PDF.

Marketplace

Browse expert services and manage orders.

GET /api/marketplace/catalog/categories List marketplace categories and services.
GET /api/marketplace/catalog/services/{service} Fetch service packages, fields, and extras.
GET /api/marketplace/orders List marketplace orders for the authenticated user.
POST /api/marketplace/orders Place a new marketplace order.
POST /api/marketplace/orders/{order}/transition Advance an order through its workflow.

Payments

Create payments, view history, and process refunds.

GET /api/payments List payments for the authenticated user.
POST /api/payments Initiate a payment for a payable entity.
GET /api/payments/{payment} Fetch payment details and status.
POST /api/payments/{payment}/refund Request a refund for an eligible payment.
POST /api/payments/webhooks/moyasar Moyasar webhook callback (unsigned, provider verified).
POST /api/payments/webhooks/tuwaiq-pay Tuwaiq Pay webhook callback (HMAC signature verified).

AI

Generate content and manage AI credit balances.

POST /api/ai/generate Run an AI generation prompt against a template.
GET /api/ai/balance Fetch remaining AI credits for the user.
GET /api/ai/prompts List available AI prompt templates.
GET /api/ai/credit-packs List purchasable AI credit packs.
POST /api/ai/credit-packs/purchase Purchase an AI credit pack.

Integrations

Configure outbound webhooks and inspect deliveries.

GET /api/integrations/events List supported integration event types.
GET /api/integrations/endpoints List webhook endpoints for the organization.
POST /api/integrations/endpoints Register a new webhook endpoint.
GET /api/integrations/endpoints/{endpoint}/deliveries Inspect delivery attempts for an endpoint.

Search

Unified search across public platform entities.

GET /api/search?q=&type= Search resumes, jobs, services, products, profiles, and portfolios. Optional type filter.

Platform Query API (legacy /graphql alias)

GraphQL-shaped syntax only — not a GraphQL server. Cross-engine reads use published contracts.

GET /api/platform-query/schema Returns SDL describing supported root selections.
POST /api/platform-query Execute supported queries such as `{ viewer { id name } }`. Auth required.
GET /api/graphql/schema Deprecated alias of /api/platform-query/schema.
POST /api/graphql Deprecated alias of /api/platform-query.