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

API

API EMD Cloud — это программный интерфейс для взаимодействия с платформой, который позволяет разработчикам интегрировать функциональность EMD Cloud в свои приложения и сервисы.

Для кого это?​

API предназначен для Backend-разработчиков и Full-stack разработчиков, которым необходимо:

  • Программно управлять данными в базе данных
  • Интегрировать авторизацию и управление пользователями
  • Работать с файловым хранилищем
  • Создавать и управлять чатами
  • Настраивать автоматизацию и вебхуки
  • Интегрировать EMD Cloud с внешними сервисами

Интерактивная документация​

important

Полная интерактивная документация API доступна для каждого пространства (проекта) по адресу:

https://console.cloud.emd.one/app/{app-id}/api/

Где {app-id} — это идентификатор вашего пространства.

В интерактивной документации вы найдёте:

  • Полный список всех методов с описанием параметров
  • Интерактивное тестирование запросов прямо в браузере
  • Примеры запросов и ответов для каждого метода
  • Схемы данных для всех объектов

Подробнее о работе с интерактивной документацией читайте в разделе Интерактивная документация.

Основные возможности​

REST API​

EMD Cloud предоставляет HTTP API для работы со всеми сервисами платформы. API построен на принципах REST и использует стандартные HTTP методы.

Формат данных​

Все запросы и ответы используют формат JSON. API поддерживает стандартные HTTP заголовки и коды ответов.

Аутентификация​

Для работы с API используется JWT токены. Подробнее об аутентификации читайте в разделе Авторизация.

Группы методов​

API EMD Cloud организован в следующие группы:

  • База данных — работа с коллекциями, записями, полями и представлениями
  • Авторизация — регистрация, аутентификация, управление сессиями
  • Пользователи — управление профилями пользователей
  • Хранилище — загрузка и управление файлами
  • Чаты — работа с сообщениями и каналами
  • Вебхуки — настройка HTTP коллбэков
  • Сценарии — управление автоматизацией
  • Секреты — хранение учётных данных для интеграций

Что дальше?​

  1. Принципы REST API — изучите базовые концепции REST
  2. Обзор методов — ознакомьтесь с группами доступных методов
  3. Примеры использования — посмотрите практические примеры
  4. API v2 — узнайте о планах развития API

SDK и альтернативы​

Если вы предпочитаете работать с готовыми библиотеками, обратите внимание на:

примечание

Мы активно работаем над API v2, который будет полностью соответствовать принципам RESTful архитектуры. Подробнее читайте в разделе Планы на v2.