Перейти к основному содержимому

Обзор методов API

API EMD Cloud организован в логические группы методов, каждая из которых отвечает за работу с определённым типом ресурсов.

important

Это обзорный раздел, описывающий основные группы методов. Полную документацию с параметрами, примерами запросов и ответов вы найдёте в интерактивной документации вашего пространства.

База данных​

Методы для работы с NoSQL базой данных — коллекциями, записями, полями и представлениями.

Коллекции (Collections)​

Управление структурой базы данных:

  • GET /database — получение списка коллекций
  • POST /database — создание новой коллекции
  • PUT /database/{id} — обновление настроек коллекции
  • DELETE /database/{id} — удаление коллекции

Записи (Records)​

CRUD операции с данными в коллекциях:

  • GET /database/{collection} — получение списка записей с фильтрацией
  • GET /database/{collection}/{id} — получение конкретной записи
  • POST /database/{collection} — создание новой записи
  • PUT /database/{collection}/{id} — обновление записи
  • DELETE /database/{collection}/{id} — удаление записи

Поля (Fields)​

Управление схемой коллекций:

  • GET /database/{collection}/fields — список полей коллекции
  • POST /database/{collection}/fields — создание нового поля
  • PUT /database/{collection}/fields/{id} — изменение настроек поля
  • DELETE /database/{collection}/fields/{id} — удаление поля

Представления (Views)​

Настройка отображения данных:

  • GET /database/{collection}/views — список представлений
  • POST /database/{collection}/views — создание представления
  • PUT /database/{collection}/views/{id} — обновление настроек
  • DELETE /database/{collection}/views/{id} — удаление представления

Кластеры (Clusters)​

Управление кластерами базы данных для масштабирования и репликации.

Индексы (Indexes)​

Создание и управление индексами для оптимизации запросов:

  • POST /database/{collection}/indexes — создание индекса
  • GET /database/{collection}/indexes — список индексов
  • DELETE /database/{collection}/indexes/{id} — удаление индекса

Авторизация​

Методы для регистрации, аутентификации и управления сессиями пользователей.

Регистрация и вход​

  • POST /auth/register — регистрация нового пользователя
  • POST /auth/login — аутентификация (получение JWT токена)
  • POST /auth/refresh — обновление токена доступа
  • POST /auth/logout — выход из системы

Восстановление пароля​

  • POST /auth/forgot-password — запрос на восстановление пароля
  • POST /auth/reset-password — установка нового пароля

Управление профилем​

  • GET /auth/me — получение данных текущего пользователя
  • PUT /auth/me — обновление профиля
  • PUT /auth/change-password — изменение пароля

Имперсонализация​

  • POST /auth/impersonate/{userId} — вход от имени другого пользователя (для администраторов)
примечание

Подробнее об авторизации читайте в разделе Авторизация.

Пользователи​

Методы для управления базой пользователей (Users/Profiles).

  • GET /users — получение списка пользователей
  • GET /users/{id} — получение данных пользователя
  • POST /users — создание пользователя
  • PUT /users/{id} — обновление данных пользователя
  • DELETE /users/{id} — удаление пользователя

Эти методы позволяют администраторам управлять пользователями через API, в отличие от методов /auth/*, которые используются для самостоятельной регистрации и управления профилем.

Хранилище​

Методы для работы с файловым хранилищем.

Загрузка файлов​

  • POST /storage/upload — простая загрузка файла
  • POST /storage/upload/tus — загрузка через протокол TUS (для больших файлов)

Управление файлами​

  • GET /storage — список файлов
  • GET /storage/{id} — получение информации о файле
  • GET /storage/{id}/download — скачивание файла
  • DELETE /storage/{id} — удаление файла
подсказка

Для загрузки больших файлов рекомендуется использовать протокол TUS, который поддерживает дозагрузку при обрыве соединения. Подробнее в разделе Хранилище.

Чаты​

Методы для работы с системой чатов и обмена сообщениями.

Сообщения​

  • GET /chats/{channelId}/messages — получение истории сообщений
  • POST /chats/{channelId}/messages — отправка сообщения
  • PUT /chats/messages/{id} — редактирование сообщения
  • DELETE /chats/messages/{id} — удаление сообщения

Каналы/Комнаты​

  • GET /chats/channels — список каналов
  • POST /chats/channels — создание канала
  • PUT /chats/channels/{id} — обновление настроек канала
  • DELETE /chats/channels/{id} — удаление канала

Участники​

  • GET /chats/{channelId}/members — список участников канала
  • POST /chats/{channelId}/members — добавление участника
  • DELETE /chats/{channelId}/members/{userId} — удаление участника
примечание

Для real-time обмена сообщениями рекомендуется использовать WebSocket соединение. Подробнее в разделе Чаты.

Вебхуки​

Методы для настройки HTTP коллбэков при наступлении событий в системе.

  • GET /webhooks — список вебхуков
  • POST /webhooks — создание вебхука
  • PUT /webhooks/{id} — редактирование вебхука
  • DELETE /webhooks/{id} — удаление вебхука
  • GET /webhooks/{id}/logs — логи выполнения вебхука

Вебхуки позволяют отправлять HTTP запросы на внешние URL при определённых событиях (создание записи, обновление, удаление и т.д.).

Сценарии​

Методы для управления сценариями автоматизации (воркфлоу).

  • GET /scenarios — список сценариев
  • POST /scenarios — создание сценария
  • PUT /scenarios/{id} — редактирование сценария
  • DELETE /scenarios/{id} — удаление сценария
  • POST /scenarios/{id}/activate — запуск сценария
  • POST /scenarios/{id}/deactivate — остановка сценария
  • GET /scenarios/{id}/executions — история выполнения
примечание

Визуальное создание и редактирование сценариев доступно в разделе Автоматизация консоли. API методы предназначены для программного управления.

Секреты​

Методы для безопасного хранения учётных данных, используемых в интеграциях.

  • GET /credentials — список сохранённых секретов
  • POST /credentials — создание нового секрета
  • PUT /credentials/{id} — обновление секрета
  • DELETE /credentials/{id} — удаление секрета

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

предупреждение

Значения секретов никогда не возвращаются через API после создания. Вы можете только обновить или удалить секрет, но не прочитать его значение.

Что дальше?​