Аутентификация
Как получить Workspace API Key, передавать его в запросах и читать ответы.
Аутентификация
Получить токен
- Откройте Настройки группы → API-ключи (
/account/settings/api-keys). - Нажмите «Создать ключ».
- Задайте имя (необязательно) и выберите нужные скоупы.
- Нажмите «Создать» — токен показывается один раз. Скопируйте сразу.
Токен выглядит так:
fmxk_a3f9c2e1b8d047a59f620e3c1b4d8a7f9e2c0d1b3a5f7e9c
Передача токена в запросах
Добавляйте заголовок Authorization к каждому запросу:
Authorization: Bearer fmxk_ваш_токен_здесь
Пример с curl:
curl https://framix.app/api/projects/list \
-H "Authorization: Bearer fmxk_ваш_токен"
Базовый URL
Все API-маршруты начинаются с:
https://framix.app/api/
Формат ответов
Все эндпоинты возвращают JSON одной структуры:
{
"data": {
"status": true,
"message": "Projects fetched",
"projects": [...],
"pagination": { "total": 12, "page": 1, "limit": 10 }
}
}
| Поле | Тип | Описание |
|---|---|---|
data.status | boolean | true — успех, false — ошибка |
data.message | string | Человекочитаемое сообщение |
| Остальные поля | any | Зависят от эндпоинта (смотрите справочник) |
При ошибке:
{
"data": {
"status": false,
"message": "Auth Error"
}
}
HTTP-коды ошибок
| Код | Значение |
|---|---|
401 | Токен не передан или не найден |
403 | Токен найден, но у него нет нужного скоупа — или запрошенный путь заблокирован безусловно |
422 | Неверные параметры запроса |
404 | Ресурс не найден |
500 | Серверная ошибка |
Workspace-контекст
Токен привязан к конкретной группе. Сервер определяет её автоматически — вам не нужно передавать workspaceId в каждом запросе. Все операции работают именно в той группе, в которой был выдан ключ.
Безопасность
- Токен в базе не хранится в открытом виде — только SHA-256 хэш. Если потеряете — создайте новый.
- Выдавайте минимально необходимые скоупы: скрипту для чтения товаров нужен только
products:read. - Для операций с финансами (баланс, платежи, карты) API-ключи не работают — это намеренное ограничение.