Начало работы с REST API HubEx

Этот раздел поможет вам быстро подключиться к API HubEx, настроить авторизацию и выполнить первые запросы. Мы рассмотрим пошаговый процесс от получения токена до тестирования API.

1. Подготовка к работе с API

Перед началом интеграции убедитесь, что у вас есть:

Доступ к административной панели HubEx (роль с правами на управление API)
Возможность отправлять HTTP-запросы (через Postman, cURL, Python, PHP и т. д.)
Базовое понимание REST API и формата JSON

2. Настройка API-пользователя и получение токена

Шаг 1. Создание служебного пользователя

Войдите в админку HubEx.
Перейдите в раздел:
Интеграция → Служебные пользователи.
Нажмите "Пользователь AP".
Выберите:
- Роли
- Участки

Шаг 2. Генерация сервисного токена

В разделе "Токен доступа" нажмите "Сгенерировать".
Скачайте Service Token.
- ⚠️ Токен показывается только один раз! Сохраните его в безопасное место.

Подробнее читайте в статье: Служебные пользователи

3. Получение Access Token (авторизация в API)

Для работы с API HubEx нужен JWT-токен доступа, который обновляется каждые 30 минут.

Запрос на получение Access Token

Метод: POST
URL: https://api.hubex.ru/fsm/AUTHZ/AccessTokens

Заголовки (Headers):

Content-Type: application/json

Тело запроса (Body):

{
  "serviceToken": "ваш_сервисный_токен"
}

Пример ответа (200 OK):

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

access_token — используйте его в каждом запросе.

4. Отправка первого API-запроса

Теперь можно делать запросы к HubEx, добавляя Access Token в заголовки.

Пример: Получение списка заявок

Метод: GET
URL: https://api.hubex.ru/fsm/WORK/Tasks

Заголовки:

Authorization: Bearer ваш_access_token
Content-Type: application/json
X-Application-ID: 5

Параметры (опционально):

?fetch=50         // Количество записей
&isClosed=false   // Только открытые заявки
&offset=0         // Пагинация

Ответ (успешный):

{
  "data": [
    {
      "id": "123",
      "title": "Не работает принтер",
      "status": "В работе",
      "createdAt": "2024-05-20T10:00:00Z"
    },
    ...
  ],
  "total": 150
}

5. Тестирование API (Postman, cURL, Python)

Вариант 1: Postman

Создайте новый запрос (+ New → HTTP Request).
Укажите:
- Метод: POST
- URL: https://api.hubex.ru/fsm/AUTHZ/AccessTokens
- Headers: Content-Type: application/json
- Body (raw JSON):
```
{"serviceToken": "ваш_токен"}
```
Отправьте запрос и сохраните access_token.
Теперь делайте запросы к другим endpoint’ам, добавляя заголовок:
```
Authorization: Bearer ваш_access_token
```

Вариант 2: cURL (командная строка)

# Получение токена
curl -X POST "https://api.hubex.ru/fsm/AUTHZ/AccessTokens" \
     -H "Content-Type: application/json" \
     -d '{"serviceToken": "ваш_токен"}'
# Получение списка заявок
curl -X GET "https://api.hubex.ru/fsm/WORK/Tasks" \
     -H "Authorization: Bearer ваш_access_token" \
     -H "Content-Type: application/json"

Вариант 3: Python (requests)

import requests
# 1. Получение токена
auth_url = "https://api.hubex.ru/fsm/AUTHZ/AccessTokens"
headers = {"Content-Type": "application/json"}
data = {"serviceToken": "ваш_токен"}
response = requests.post(auth_url, json=data, headers=headers)
access_token = response.json()["access_token"]
# 2. Запрос данных
tasks_url = "https://api.hubex.ru/fsm/WORK/Tasks"
headers = {
    "Authorization": f"Bearer {access_token}",
    "Content-Type": "application/json"
}
response = requests.get(tasks_url, headers=headers)
print(response.json())

6. Что делать дальше?

Изучите документацию API — какие endpoints доступны:
- AUTHN – сервис для аутентификация учетных записей
- AUTHZ – сервис для авторизации пользователей
- AUTH – сервис для работы с учетной записью и авторизационными данными
- ADM – сервис для работы с данными пользователей и администрированием
- ES – сервис для работы с компаниями, объектами, организационной структуры, локаций и т.п.
- PA – сервис для управления персоналом - трудоустройство, назначение на оборудование, рейтинги, навыки и т.п.
- WORK – сервис для работы с заявками - список заявок, основные атрибуты по заявкам (чек-листы, выполнение и т.п.), создание заявок, вложения, назначения сотрудников и т.п.
- WSP – сервис для работы с графиками рабочего времени
- COMMON – сервис для работы со справочниками: валюты, временные зоны, единицы измерения, дополнительные поля и т.п.
- SLA – сервис для работы с критичностью заявки и SLA
- TSTG – сервис настройки жизненного цикла заявки
- UI – сервис настройки пользовательского интерфейса
- EXPORT – сервис для экспорта данных
- PMP – сервис для работы с планировщиком работ
- MSG – сервис для работы с уведомлениями, Webhook, триггерами
- NEWS – сервис по оповещению пользователей по обновлениям системы
- WH – сервис для работы со складами и материалами
Настройте обработку ошибок (например, истечение токена).
Реализуйте автоматическое обновление токена (если интеграция долгосрочная).
Настройте вебхуки (если нужно получать уведомления от HubEx).

Готово! 🎉

Теперь вы можете интегрировать HubEx с CRM, 1С, Telegram-ботами и другими системами. Если возникнут вопросы — обратитесь в поддержку HubEx.

Перейти в меню