TehProf Support API

REST API for managing support tickets, clients, operators and integrations.

Base URL: https://support.tehprof.kz/api/

Overview

All API endpoints accept JSON request bodies (POST) and return JSON responses.

Every request includes an action parameter that specifies the operation.

{
  "action": "list_tickets",
  "status": "active",
  "page": 1
}

Successful responses:

{
  "ok": true,
  "data": { ... }
}

Error responses:

{
  "ok": false,
  "error": "Error description"
}

How to Get an API Key

Follow these steps to create your API key:

API Access by Plan

API access level depends on your subscription plan:

Authentication

1. API Key (Recommended for integrations)

Pass your API key via X-Api-Key header. This is the recommended method for external integrations.

POST /api/admin.php
Content-Type: application/json
X-Api-Key: tps_your_api_key_here

{"action": "list_tickets"}

2. Session Cookie

Login via admin_login action with your tenant email/phone and password. The server sets an httpOnly session cookie.

POST /api/admin.php
Content-Type: application/json

{"action": "admin_login", "login": "admin@company.kz", "password": "your_password"}

3. Bitrix24 OAuth

Used when embedded as a Bitrix24 app. Pass domain and auth_token.

{"action": "list_tickets", "domain": "your.bitrix24.kz", "auth_token": "..."}

4. Mobile Session (HMAC)

Lightweight token-based auth for mobile/external apps. Pass via X-Mobile-Token header or mobile_token in request body.

Error Handling

Tickets

Response: list_tickets

{
  "ok": true,
  "data": {
    "tickets": [
      {
        "id": 42,
        "subject": "CRM не синхронизируется",
        "status": "in_progress",
        "priority": "urgent",
        "category": "crm",
        "portal_domain": "client.bitrix24.kz",
        "company_name": "ТОО Рога и Копыта",
        "assigned_to": 5,
        "assigned_name": "Алия Нурбекова",
        "created_at": "2026-03-19T10:30:00.000Z",
        "updated_at": "2026-03-20T08:15:00.000Z",
        "creator_name": "Иван Петров",
        "message_count": 7,
        "unread_count": 2
      }
    ],
    "total": 156,
    "page": 1,
    "limit": 30
  }
}

Response: get_ticket

{
  "ok": true,
  "data": {
    "ticket": {
      "id": 42,
      "subject": "CRM не синхронизируется",
      "description": "После обновления контакты не подтягиваются...",
      "status": "in_progress",
      "priority": "urgent",
      "category": "crm",
      "portal_domain": "client.bitrix24.kz",
      "assigned_to": 5,
      "assigned_name": "Алия Нурбекова",
      "created_at": "2026-03-19T10:30:00.000Z",
      "sla_response_at": "2026-03-19T11:00:00.000Z",
      "sla_response_breached": false
    },
    "messages": [
      {
        "id": 101,
        "message": "После обновления контакты не подтягиваются...",
        "author_type": "client",
        "author_name": "Иван Петров",
        "is_note": false,
        "created_at": "2026-03-19T10:30:00.000Z",
        "files": []
      },
      {
        "id": 102,
        "message": "Проверяю настройки синхронизации, отпишу через 10 минут",
        "author_type": "support",
        "author_name": "Алия Нурбекова",
        "is_note": false,
        "created_at": "2026-03-19T10:45:00.000Z",
        "delivery_status": "read",
        "files": []
      }
    ],
    "files": []
  }
}

Response: create_ticket

{
  "ok": true,
  "data": {
    "id": 43,
    "subject": "Новая заявка из мониторинга",
    "status": "new",
    "created_at": "2026-03-20T09:00:00.000Z"
  }
}

Ticket Lifecycle Actions API Key: write + tickets

Messages

Response: dashboard

{
  "ok": true,
  "data": {
    "total_open": 12,
    "total_new": 3,
    "total_in_progress": 7,
    "total_done": 2,
    "total_on_hold": 1,
    "avg_response_min": 18,
    "avg_resolution_hours": 4.5,
    "sla_compliance_pct": 92,
    "per_portal": [
      { "portal_domain": "client.bitrix24.kz", "company_name": "ТОО Рога и Копыта", "open": 5, "new": 1 },
      { "portal_domain": "other.bitrix24.kz", "company_name": "ИП Сидоров", "open": 7, "new": 2 }
    ]
  }
}

Clients & Contacts

Response: list_clients

{
  "ok": true,
  "data": [
    {
      "portal_domain": "client.bitrix24.kz",
      "company_name": "ТОО Рога и Копыта",
      "tariff_plan": "standard",
      "hours_per_month": 20,
      "hours_used": 12.5,
      "ticket_stats": { "open": 5, "done_month": 8, "total": 47 }
    }
  ]
}

Operators

Dashboard & Analytics

Knowledge Base

Reference Data

Admin-Only Endpoints

Client API

Client-facing API for end-users. Authenticated via B24 OAuth or Client Token (X-Client-Token header).

Widget API

Public API for the embeddable support widget (no user auth, API key only).

Widget Embed Code

<script src="https://support.tehprof.kz/widget/loader.js"
  data-api-key="YOUR_WIDGET_API_KEY"
  data-lang="ru"></script>

Channel Webhooks

Receive incoming messages from external channels.

Client Token (Passwordless Access)

Generate a token for your client to access the support portal without login. Perfect for embedding support into your own portal.

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{"action":"create_client_token","portal_domain":"client.bitrix24.kz","user_id":123,"user_name":"John"}'

Response:

{
  "ok": true,
  "data": {
    "token": "ct_eyJ0IjoxLCJwI...",
    "expires_in": 86400,
    "portal_url": "https://support.tehprof.kz/index.html?ctoken=ct_...",
    "embed_url": "https://support.tehprof.kz/embed.html?ctoken=ct_..."
  }
}

Embed (iframe)

Embed the support portal into your website or application using an iframe with a client token.

Quick Embed

<iframe
  src="https://support.tehprof.kz/embed.html?ctoken=CLIENT_TOKEN_HERE"
  style="width:100%;height:600px;border:none;border-radius:8px"
  allow="microphone;camera;display-capture"
></iframe>

Dynamic Token (Server-Side)

Your backend generates a fresh token for each user session:

// Your backend (Node.js example)
app.get('/support', async (req, res) => {
  const response = await fetch('https://support.tehprof.kz/api/admin.php', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-Api-Key': 'tps_your_api_key'
    },
    body: JSON.stringify({
      action: 'create_client_token',
      portal_domain: 'client.bitrix24.kz',
      user_id: req.user.id,
      user_name: req.user.name,
      ttl: 28800 // 8 hours
    })
  });
  const { data } = await response.json();
  res.render('support', { embedUrl: data.embed_url });
});

Quick Start Examples

Copy-paste these examples to get started quickly. Replace tps_your_key with your actual API key.

1. List all open tickets

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{"action":"list_tickets","status":"active"}'

2. Create ticket from monitoring alert

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{
    "action": "create_ticket",
    "subject": "Server CPU > 90%",
    "description": "Alert from Zabbix: host prod-01, CPU 94% for 5 min",
    "priority": "urgent",
    "category": "infrastructure",
    "portal_domain": "client.bitrix24.kz"
  }'

3. Reply to a ticket

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{
    "action": "add_message",
    "ticket_id": 42,
    "message": "Fixed. CPU dropped to 35% after restarting the service."
  }'

4. Close a ticket

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{
    "action": "complete_ticket",
    "ticket_id": 42,
    "result": "Service restarted, monitoring confirmed normal operation"
  }'

5. Get dashboard stats (for your TV/BI dashboard)

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{"action":"dashboard"}'

6. Generate client access token (embed support into your portal)

curl -X POST https://support.tehprof.kz/api/admin.php \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: tps_your_key" \
  -d '{
    "action": "create_client_token",
    "portal_domain": "client.bitrix24.kz",
    "user_id": 123,
    "user_name": "Иван Петров",
    "ttl": 28800
  }'

Ticket State Machine

new → estimated → in_progress → done → closed
                      ↕ on_hold
           closed → reopened → in_progress

Categories