Appearance
Миграция с /transact
Метод POST https://api.rees46.ru/transact устарел. Он продолжает работать, но новые возможности — каскады с деревом правил, идемпотентность, статус и отмена — доступны только в новом API:
POST https://app.rees46.ru/api/v3/communications/transactionalAPI находится на домене личного кабинета: app.rees46.ru для России и app.rees46.kz для Казахстана. В on-premise кластере у API свой домен.
Каскады через старый адрес
Старый метод исполняет каскады по старым правилам: сначала отправка во все обязательные каналы, затем перебор остальных каналов до первой успешной отправки, без ожидания статуса доставки. Дерево правил, проверки доставки и задержки работают только при вызове через новый API.
Отличия
| Что | /transact | /api/v3/communications/transactional |
|---|---|---|
| Адрес | https://api.rees46.ru/transact | https://app.rees46.ru/api/v3/communications/transactional |
| Авторизация | shop_id, shop_secret | shop_id, shop_secret только в теле запроса, не в query string |
| Признак успеха | Поле success: true/false | Поле status: "success"/"fail" |
| Тело ответа | payload.code | payload.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"
}
}Порядок перехода
- Замените адрес запроса.
- Проверяйте результат по полю
statusи HTTP-коду ответа вместо поляsuccess. Текст ошибки — в полеmessageна верхнем уровне ответа. - Уберите
did, если вы его передавали. Передавайтеmax_id, если используете канал Max. - Если использовали
send_everywhere, настройте отправку в несколько каналов в дереве правил каскада. - Добавьте заголовок
Idempotency-Keyк запросам, которые вы повторяете при сетевых ошибках. См. Идемпотентность.