Точка входа и основные параметры

Owned by Zelenin Artem
Last updated: Oct 12, 2018 by Svetlana Denisova
1 min read

Точка входа

Для доступа к Public API v2 необходимо указать в http headers поля TOKEN и APPID:

  • TOKEN - токен, по которому происходит обращение к API
  • APPID - название аккаунта пользователя, которому принадлежит токен

Успешность доступа можно проверить запросив 


Пример ответа:

Основные параметры

Все GET запросы имеют следующие параметры
ПараметрТипОписаниеОбязательный
pageintстраница которую необходимо получитьнет
page_sizeintразмер страницы, по умолчанию 50, максимум 100

нет

Так же следующую и предыдущую страницу, если они есть, можно получить из тела ответа.


Таким образом для доступа к товарам с 2001 по 2100 необходимо сделать следующий запрос

Ответ:

Таблица кодов ответа на успешный запрос

Метод запросаОписаниеКод
GETПолучение списка объектов или одного объекта200
POSTСоздание объекта201
PATCHИзменение объекта200
DELETEУдаление объекта204

Таблица кодов ответа на неудавшийся запрос

Метод запросаОписание проблемыКод
ЛюбойTOKEN и/или APPID переданы не верно или недействительны403
Объект не существует404
Переданы неверные параметры запроса или отсутствует обязательный параметр400

На неудавшиеся запросы в теле ответа всегда есть описание проблемы, например:

Brandquad Public API v2.x