API web-to-print TCSДокументация для разработчиков
Главная / Обращения с сайта

Информация об обращении

Возвращает полные данные одного обращения.

Ссылка на API

https://your_site/api/callback/info

Параметры запроса

Метод вызывается через POST. Поле key передаётся на верхнем уровне, а параметры метода - в объекте data.

ПолеТипОбязательноеОписание
keyStringДаСекретный API-ключ, выданный для сайта.
dataObjectДаКонтейнер параметров конкретного метода.
data.idinteger, обязательный.ДаID обращения с сайта в TCS.

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

POST /api/callback/info
Content-Type: application/json

{
    "key": "ваш-api-ключ",
    "data": {
        "id": 1024
    }
}

Параметры ответа

ПолеТипОбязательноеОписание
successBooleanДаtrue при успешном JSON-ответе; false при ошибке.
errorArray / ObjectДаПустой массив либо объект ошибки.
error.codeIntegerНетКод ошибки.
error.messageStringНетТекст ошибки.
data.idIntegerДаID обращения.
data.statusIntegerДаID статуса.
data.dateCreateStringДаДата создания.
data.urlStringНетМожет отсутствовать. Страница-источник.
data.noteStringНетМожет отсутствовать. Комментарий.
data.params[]Array<Object>Даtype, label, value; у файла value - ссылка на него.

Пример успешного ответа

{
    "success": true,
    "error": [],
    "data": [
        "..."
    ]
}
Ошибки: API может вернуть коды 1 - авторизация, 2 - данные не найдены, 3 - сохранение, 4 - недостаточно данных, 5 - неверный формат, 6 - валидация, 7 - доступ, 8 - не указан менеджер.