Skip to content

Проверка, что пользователь находится в сегменте

Метод возвращает результат проверки, находился ли пользователь в конкретном сегменте или нет.

Метод может работать только как S2S.

POST https://api.rees46.ru/segments/includes

Параметры

ПараметрТипОбязателен?Описание
shop_idStringДаAPI-ключ
shop_secretStringДаСекретный API-ключ
segment_idIntegerДаИдентификатор сегмента
email*StringДаEmail клиента
phone*StringДаТелефон клиента
external_id*StringДаВнешний идентификатор клиента
loyalty_id*StringДаИдентификатор участника во внешней программе лояльности
telegram_id*StringДаTelegram ID клиента

Обязательные свойства

Параметры, отмеченные [*] - обязателен хотя бы один из них.

Запрос

Пример запроса:

shell
# С обоими идентификаторами
curl -d "shop_id=...&shop_secret=...&email=...&phone=...&segment_id=..." https://api.rees46.ru/segments/includes

# Только с телефоном
curl -d "shop_id=...&shop_secret=...&phone=...&segment_id=..." https://api.rees46.ru/segments/includes

# Только с email
curl -d "shop_id=...&shop_secret=...&email=...&segment_id=..." https://api.rees46.ru/segments/includes

Ответ

Пример ответа сервера:

json
true

Внимание

В будущем структура будет приведена к стандарту ответа:

json
{
  "status": "success",
  "payload": {
    "segment_id": 33,
    "result": true
  }
}

Рекомендуем подготовить обработчик ответа под новую структуру, чтобы ваша интеграция не сломалась.

В случае ошибки ответ будет в формате:

json
{
  "status": "error",
  "payload": {
    "message": "Shop not found"
  }
}