Bargardon API (1.2.0)

Authenticate with email and password. Returns a Sanctum personal access token for Authorization: Bearer ....

Example request:

{ "email": "user@example.com", "password": "your-password" }

Revokes only the token used for this request.

Revokes every personal access token belonging to the user.

Returns the authenticated user model as JSON (Sanctum-protected).

Returns metadata for each token (not the secret value).

Creates a new personal access token. The plaintext token is returned once in data.token; store it securely.

Example:

{ "name": "CI / Production" }

Deletes a token by ID. The ID is the numeric identifier from the list endpoint (may be passed as string or integer in the path).

Submit text for translation. Content is split into sentences and processed via Google Sheets (GOOGLETRANSLATE).

Billing: Subject to RPM limits, wallet balance, and related billing rules; may return 429 when throttled or 402 when payment is required.

Wait: Default poll/wait window is 5 seconds; override with wait_seconds (1–60).

Optional header Idempotency-Key: Send a unique key per logical request to avoid duplicate charges; replays may include Idempotency-Replayed: true.

Example body:

{
  "text": "Hello world. This is a test.",
  "source_language": "en",
  "target_language": "fa",
  "wait_seconds": 5
}

Returns the current user's wallet (created on first access if missing).

Balances are in Iranian rials (*_rials fields).

Example response (data):

{
  "id": 1,
  "balance_rials": 75000,
  "frozen_rials": 0,
  "lifetime_spent_rials": 120000,
  "low_balance_threshold_rials": 25000,
  "auto_topup": {
    "enabled": false,
    "threshold_rials": 0,
    "amount_rials": 0
  },
  "updated_at": "2026-05-01T12:00:00.000000Z"
}

Partial update of low-balance alert threshold and optional auto top-up settings.

Example:

{
  "low_balance_threshold_rials": 25000,
  "auto_topup_enabled": true,
  "auto_topup_threshold_rials": 20000,
  "auto_topup_amount_rials": 500000
}

Paginated ledger entries (credits, debits, reserves, top-ups, etc.).

Query parameters:

• type — filter by WalletTransactionType (e.g. topup, debit, credit)
• from / to — filter created_at (inclusive bounds as interpreted by the backend)
• per_page — page size (1–100, default 25)

Example: GET /wallet/transactions?type=topup&per_page=10

Paginated API usage records (endpoint, units, costs, status).

Query: endpoint, status (reserved, settled, failed, refunded), per_page (1–100, default 25).

Example: GET /wallet/usage?status=settled&per_page=20

Aggregates usage over a sliding window: day (default), week, or month.

Returns per-day rows plus totals for the selected period.

Example: GET /wallet/usage/stats?period=week

Creates a pending payment and returns a gateway redirect URL for the user to complete payment.

• amount_rials is required (10_000–1_000_000_000 rials).
• callback_url is optional (stored on the transaction; gateway callback also uses the app route payments.callback).
• gateway is optional; defaults to config('payments.default') (e.g. Zarinpal).

Example:

{
  "amount_rials": 500000,
  "gateway": "zarinpal",
  "callback_url": "https://your-app.example/profile/wallet"
}

Returns languages ordered by name. Optional filters:

• is_active — boolean
• code — exact language code
• has_active_courses — when true, only languages tied to published courses (source or target)

Note: The JSON key for the collection is language (singular), not languages.

Example: GET /languages?is_active=true

Creates a language record. Validation errors use status: error and an errors object (not identical to Laravel's default JSON shape).

Example:

{
  "name": "English",
  "code": "en",
  "native_name": "English",
  "description": "English language",
  "is_active": true,
  "is_rtl": false,
  "countries": ["US", "GB"]
}

Returns a single language by ID.

Full or partial update via PUT. All fields optional except uniqueness rules apply when a field is present.

Example:

{ "is_active": false, "description": "Archived" }

Soft-deletes the language (if the model uses soft deletes).