Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Точка входа
Для доступа к Public API v2 необходимо указать в http headers поля TOKEN и APPID:
- TOKEN - токен, по которому происходит обращение к API
- APPID - название аккаунта пользователя, которому принадлежит токен
Успешность доступа можно проверить запросив
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl https://[your_domain].brandquad.ru/api/public_v2/ -H "TOKEN: 1234567890ABCDIEGHPR" -H "APPID: acc" |
Пример ответа:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"API Version": "2",
"API base url": "https://[your_domain].brandquad.ru/api/public_v2/"
} |
Основные параметры
| Info | ||
|---|---|---|
| ||
| Все GET запросы имеют следующие параметры |
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| page | int | страница которую необходимо получить | нет |
| page_size | int | размер страницы, по умолчанию 50, максимум 100 | нет |
Так же следующую и предыдущую страницу, если они есть, можно получить из тела ответа.
Таким образом для доступа к товарам с 2001 по 2100 необходимо сделать следующий запрос
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl https://[your_domain].brandquad.ru/api/public_v2/products/?page=21&page_size=100 -H "TOKEN: 1234567890ABCDIEGHPR" -H "APPID: acc" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"count": 2441,
"next": "https://[your_domain].brandquad.ru/api/public_v2/products/?page=22&page_size=100",
"previous": "https://[your_domain].brandquad.ru/api/public_v2/products/?page=20&page_size=100",
"results": [...]
} |
Таблица кодов ответа на успешный запрос
| Метод запроса | Описание | Код |
|---|---|---|
| GET | Получение списка объектов или одного объекта | 200 |
| POST | Создание объекта | 201 |
| PATCH | Изменение объекта | 200 |
| DELETE | Удаление объекта | 204 |
Таблица кодов ответа на неудавшийся запрос
| Метод запроса | Описание проблемы | Код |
|---|---|---|
| Любой | TOKEN и/или APPID переданы не верно или недействительны | 403 |
| Объект не существует | 404 | |
| Переданы неверные параметры запроса или отсутствует обязательный параметр | 400 |
На неудавшиеся запросы в теле ответа всегда есть описание проблемы, например:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"name": [
"Это поле обязательно."
]
} |
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"detail": "Не найдено."
} |
| Table of Contents | ||
|---|---|---|
|