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

API пользователя

Взаимодействие с API

Матчинг

Профили

Импортировать профиль
Обновить профиль
Добавить профиль в базу данных
Получить информацию о профиле
Импортировать профиль в RabbitMQ
Массовое добавление профилей в базу данных
Массовое обновление профилей
Массовый импорт профилей
Приостановить все профили в базе данных
Восстановить все приостановленные профили в базе данных
Удалить профиль
Упрощенный импорт профиля
Функциональное обновление полей базы
Функциональное обновление полей подписки
Выгрузка профилей в файл
Получение данных по нескольким профилям
Объединение нескольких профилей
Отписать профиль от ресурса
Разделение профиля
- Получить историю одного профиля
  Получить историю нескольких профилей
- Добавить связь
  Удалить связь
  Усилить/ослабить связь
  Перезаписать значения свойств связи
  Получить информацию о связях профиля
  Получить список связей профиля
- Добавить или редактировать подписку
  Получить все подписки профиля
  Получить все подписки нескольких профилей
  Получить информацию о подписке профиля
  Удалить подписку профиля
  Восстановить удаленную подписку профиля
  Приостановить все подписки
  Восстановить все приостановленные подписки

Базы данных

Получить список баз данных
Получить информацию о базе данных
Получить информацию о полях базы данных
Очистка базы данных для тестирования
Получить статистику по базе данных
Обновить статистику по базе данных

Ресурсы

Получить список ресурсов
Получить информацию о ресурсе
Получить информацию о полях подписки ресурса
Получить статистику по ресурсам
Обновить статистику по ресурсам

Сегменты

Добавить сегмент
Обновить сегмент
Получить информацию о сегменте
Получить список сегментов
Удалить сегмент
Получить статистику по сегментам
Обновить статистику по сегментам
Добавить или удалить профиль
Получить данные профилей статического или обновляемого сегмента

Стоп-списки

Добавить стоп-список
Переименовать стоп-список
Получить информацию о стоп-списке
Получить информацию о нескольких стоп-списков
Удалить стоп-список
Выгрузить данные из стоп-списка в файл
- Проверить email-адрес в стоп-списке
  Добавить email-адрес в стоп-список
  Добавить один или несколько email-адресов в стоп-список
  Удалить email-адрес из стоп-списка
  Удалить все email-адреса из стоп-списка
  Проверить домен в стоп-списке
  Добавить домен в стоп-список
  Добавить один или несколько доменов в стоп-список
  Удалить домен из стоп-списка
  Удалить все домены из стоп-списка
  Проверить номер телефона в стоп-списке
  Добавить номер телефона в стоп-список
  Добавить один или несколько номеров в стоп-список
  Удалить номер из стоп-списка
  Удалить все номера из стоп-списка

Шаблоны

Получить список шаблонов
Получить информацию о шаблоне
Удалить шаблон
Добавить шаблон сообщения
Обновить шаблон сообщения
Channel object

Рассылки

Получить список рассылок
Получить информацию о рассылке
Получить лог рассылки
Клонировать рассылку
Удалить рассылку
Активировать рассылку
Деактивировать рассылку
Получить статус рассылки
- Получить список броадкаст рассылок
  Получить информацию о броадкаст рассылке
  Добавить броадкаст рассылку
  Обновить броадкаст рассылку
  Запустить броадкаст рассылку
- Получить список регулярных рассылок
  Получить информацию о регулярной рассылке
  Добавить регулярную рассылку
  Обновить регулярную рассылку
  Запустить регулярную рассылку
- Получить список триггерных рассылок
  Получить информацию о триггерной рассылке
  Добавить триггерную рассылку
  Обновить триггерную рассылку
  Запуск триггерной рассылки (API call)
  Импорт профиля + Отправка триггера
  Задание на массовую отправку триггера
  Задание на массовый импорт профилей + отправка триггера
  Массовая отправка триггера
  Массовый импорт профилей + отправка триггера
  Клонировать триггер рассылку
  Data array

Кампании

Получить информацию о кампании
Получить список кампаний
Активация кампании
Завершение кампании
Деактивация кампании
Получить статус кампании

Сценарии (цепочки)

Отправить профиль клиента в сценарий
Одновременный импорт и запуск профиля в сценарий
Массовый импорт и запуск профилей в сценарий
Задание на массовый импорт и запуск профилей в сценарий
Получить список сценариев
Активировать сценарий
Деактивировать сценарий

Промокоды

Импортировать промокоды
Получить информацию о промокоде
Активировать промокод
Обновить промокод
Привязать промокод к профилю
Отвязать промокод от профиля
Получить все промокоды

Программы лояльности

Получить уровень профиля в программе лояльности
Экспорт транзакций баллов
Сгораемые баллы за период
Получение транзакций по счёту профиля
Получение списка триггерных промоакций
Начисление баллов участнику
Списание баллов участника
Подтверждение временной транзакции
Предварительный расчет заказа
Подтверждение заказа
Отмена временной транзакции
Отмена балльной транзакции
Получение баланса балльного счёта
Регистрация участника в программе лояльности
Удаление участника из программы лояльности

Цели

Регистрация события достижения цели

Пуши приложений

Обработка и добавление подписки
Добавить события с app push

Маркет

- Структура заказа (order data object)
  Product data object
  Структура SKU (SKU data object)
  Категории (categories array)
  Custom fields array
- Импорт заказа и статусов позиций
  Получить список заказов
  Удалить заказ
  Получить статус заказа
  Изменение статуса позиции заказа
- Импорт продуктов, SKU и категорий
  Получение списка продуктов
  Получение списка SKU
  Импорт SKU и категорий
  Удалить продукты
  Удалить SKU

Отчеты и статистика

Получить сводный отчет
Получить отчет о возвратах
Получить отчет о недоставках

Сендеры

Получить список сендеров
- Получить список виртуальных сендеров
  Получить информацию о виртуальном сендере
  Клонировать виртуальный сендер
  Добавить виртуальный сендер
  Обновить виртуальный сендер
  Удалить виртуальный сендер

Объекты

AKMTA object
Content object
Email rule object
File object
Profile data object
SMS rule object
Sender object
Sender types
Start schedule object
Subscription object
Trigger types

Запросы к внешним базам данных

- Добавить запрос сегментации
  Обновить запрос сегментации
  Получить информацию о запросе сегментации
  Получить список запросов на сегментацию
  Удалить запрос сегментации
- Добавить запрос для шаблонов
  Обновить запрос для шаблонов
  Получить информацию о запросе для шаблонов
  Получить список запросов для шаблонов
  Удалить запрос для шаблонов

Прочее

Загрузить файл
Получить веб-версию сообщения
Push провайдеры
Дедупликация запросов
Работа с API через RabbitMQ
Список гендерных идентификаций
Получить допустимые значения полей browsers, devices, tz, oses, languages

Список API-методов

Импорт и настройка коллекции API-методов в Postman

SDK

- - Быстрый старт
    Конфигурация SDK
    Функционал SDK
    Публичный API SDK
    - Firebase Cloud Messaging
      Huawei Mobile Services
      RuStore
  - Быстрый старт
    Конфигурация SDK
    Функционал SDK
    Публичный API SDK
    - Apple Push Notification Service
      Firebase Cloud Messaging
      Huawei Mobile Services
  - Быстрый старт
    Конфигурация SDK
    Функционал SDK
    Публичный API SDK
    Настройка провайдеров
  Работа с ролевым и JWT-токеном

Получить список регулярных рассылок

Получить информацию о регулярной рассылке

Добавить регулярную рассылку

Обновить регулярную рассылку

Запустить регулярную рассылку