Запросы к API
В запросе необходимо передавать подключенный ранее в личном кабинете API-токен в HTTP-заголовке, пример:
Authorization: Bearer код_токена
(ключевое слово Bearer обязательно)
Request Headers
Response Body
"id": user_id,
"username": "string",
"email": "string",
"createdAt": int
}
Request Headers
Response Body
Request Headers
Response Body
Request Headers
Response Body
"_embedded": {
"leadDataDTOList": [
{
"id": lead_id,
"date": int,
"formId": int,
"status": int,
"formName": "string",
"fields": {...},
"leadInfo": {...},
"userInfo": {...},
"_links": {...}
}
]
}
}
Request Headers
Response Body
"id": lead_id,
"date": int,
"formId": int,
"status": int,
"formName": "string",
"fields": {...},
"leadInfo": {...},
"userInfo": {...}
}
Request Headers
Response Body
Фильтры
Пагинация
Следующий запрос выводит список всех заявок:
В этом случае по умолчанию придет список из десяти заявок, а в конце ответа можно увидеть параметры:
- size – количество заявок на одной странице;
- totalElements – общее число заявок;
- totalPages – общее число страниц;
- number – показатель текущей страницы.
Response Body
"_embedded": {
"leadDataDTOList": [...]
},
"page": {
"size": int,
"totalElements": int,
"totalPages": int,
"number": int
}
}
Чтобы изменить вывод, необходимо в запрос включить параметры size и page.
Например, для вывода 20 заявок на второй странице запрос выглядит так:
Response Body
"_embedded": {
"leadDataDTOList": [...]
},
"page": {
"size": 20,
"totalElements": 55,
"totalPages": 3,
"number": 0
}
}
Меняйте вывод по количеству заявок с помощью параметра size или переходите по страницам, изменяя значение page.
Request Headers
Response Body
Request Headers
Response Body
"_embedded": {
"leadDataDTOList": [
{
"id": lead_id,
"date": int,
"formId": int,
"status": int,
"formName": "string",
"fields": {...},
"leadInfo": {...},
"userInfo": {...},
"_links": {...}
}
]
}
}
Оставить комментарий