Skip to content

Миграция с /transact ​

Метод POST https://api.rees46.ru/transact устарел. Он продолжает работать, но новые возможности — каскады с деревом правил, идемпотентность, статус и отмена — доступны только в новом API:

POST https://app.rees46.ru/api/v3/communications/transactional

API находится на домене личного кабинета: app.rees46.ru для России и app.rees46.kz для Казахстана. В on-premise кластере у API свой домен.

Каскады через старый адрес

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

Отличия ​

Что/transact/api/v3/communications/transactional
Адресhttps://api.rees46.ru/transacthttps://app.rees46.ru/api/v3/communications/transactional
Авторизацияshop_id, shop_secretshop_id, shop_secret только в теле запроса, не в query string
Признак успехаПоле success: true/falseПоле status: "success"/"fail"
Тело ответаpayload.codepayload.code и payload.type (message или cascade)
Ошибка{"success": false, "payload": {"message": "..."}}{"status": "fail", "message": "..."} и HTTP-код ошибки
Идентификаторыemail, phone, external_id, loyalty_id, telegram_idПлюс max_id. did не поддерживается
Отправка во все каналы каскадаФлаг send_everywhereФлага нет, задается деревом правил каскада
Файлы в каскадеНе поддерживаютсяПрикладываются к email-шагам каскада
ИдемпотентностьНетЗаголовок Idempotency-Key или поле idempotency_key
Статус и отменаНетМетоды статуса и отмены
Только в составе каскадаНетПрямой вызов такой рассылки возвращает 422

Остальные параметры — code, variables, cc, bcc, test, файлы в multipart/form-data — передаются так же, как раньше.

Пример ​

Было:

json
{
  "success": true,
  "payload": {
    "code": "..."
  }
}

Стало:

json
{
  "status": "success",
  "payload": {
    "code": "...",
    "type": "message"
  }
}

Порядок перехода ​

  1. Замените адрес запроса.
  2. Проверяйте результат по полю status и HTTP-коду ответа вместо поля success. Текст ошибки — в поле message на верхнем уровне ответа.
  3. Уберите did, если вы его передавали. Передавайте max_id, если используете канал Max.
  4. Если использовали send_everywhere, настройте отправку в несколько каналов в дереве правил каскада.
  5. Добавьте заголовок Idempotency-Key к запросам, которые вы повторяете при сетевых ошибках. См. Идемпотентность.