Сообщения об ошибках

  1. Общие сведения

Данная часть API предназначена для отправки сообщений об ошибках в данных. Доступ к данному функционалу имеют только компании со статусом "Действующий участник"

 

2. Авторизация

Авторизация запроса происходит по API-KEY, который должен быть указан в HEADER каждого запроса.

Коды состояния ответа сервера

  • 200 - OK.

  • 400 - Bad Request.

  • 401 - You must be authorized to view this page.

  • 403 - Forbidden

  • 404 - The requested URL was not found.

  • 500 - The server encountered an error processing your request.

  • 501 - The requested method is not implemented.

  • 505 - HTTP Version Not Supported

 

3. Отправка сообщения об ошибке с карточке товара

Для отправка сообщения об ошибке с карточке товара необходимо вызвать POST запрос на адрес https://catalog.raec.su/api/errorMessage/product.

Все параметры должны быть переданы в массиве data.

Полный перечень возможных параметров.

Параметр

Описание

Возможные значения

Параметр

Описание

Возможные значения

raec_id

RAEC ID товара

int

sender_fio

ФИО отправителя

string

sender_phone

Телефон отправителя

string

sender_email

Email отправителя

string

checkbox

Отмеченные чекбоксы. Массив строковых значений с названиями атрибутов товара. Рекомендуемые значения:

  • Бренд

  • Наименование поставщика

  • Код поставщика / артикул компании

  • Проблема с привязкой RAEC_ID

  • Подозрение на дубль

  • Класс ETIM

  • Технические свойства ETIM

  • Тип изделия

  • Изображение

  • Описание товара

  • Ссылка на сайт поставщика

  • Код Youtube

  • Серия

  • Серия маркетинговая

  • Статус поставщика

  • Сертификат

  • Цена

  • Остатки поставщика

  • Остатки Участника

  • Некорректный аналог

  • Весо-габаритные характеристики

  • Кол-во в упаковке / кратность

array [“Класс ETIM”,”Сертификат”,”Кол-во в упаковке / кратность”]

comment

Произвольный текстовый комментарий

string

page

Страница запроса (url ссылка на которой видна ошибка)

url

*Красным отмечены обязательные параметры

*Синим отмечены параметры обязательные по условию. Должен быть заполнен чекбокс(ы) ИЛИ комментарий.

 

Пример кода на PHP с использование клиента

1 2 3 4 5 6 7 8 9 10 11 12 13 <?php $client = new RestClient('https://catalog.raec.su/api/', 'f85aa1473448577845a7094d4ab5bc22'); // используйте ваш ключ $response = $client->post('errorMessage/product', 'data' => [ 'raec_id' => 1, 'sender_fio' => 'Фамилия Имя Отчество', 'sender_phone' => '+7900000000', 'sender_email' => 'mail@domain.ru', 'checkbox' => [“Класс ETIM”, ”Сертификат”, ”Кол-во в упаковке / кратность”], 'comment' => 'Comment text' ] );

Пример запроса с использованием cURL

1 2 3 4 5 6 7 8 9 10 curl --location --request POST 'https://catalog.raec.su/api/errorMessage/product' \ --header 'API-KEY: ******************************' \ --form 'data[raec_id]="1"' \ --form 'data[sender_fio]="Фамилия Имя Отчество"' \ --form 'data[sender_phone]="+7900000000"' \ --form 'data[sender_email]="mail@domain.ru"' \ --form 'data[checkbox][]="Класс ETIM"' \ --form 'data[checkbox][]="Сертификат"' \ --form 'data[checkbox][]="Кол-во в упаковке / кратность"' \ --form 'data[comment]="Comment text"'

Пример ответа в случае ошибки, код ответа - 400

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "raec_id": [ "Необходимо заполнить поле «RAEC ID»." ], "sender_fio": [ "Необходимо заполнить поле «ФИО отправителя»." ], "sender_phone": [ "Необходимо заполнить поле «Телефон отправителя»." ], "sender_email": [ "Необходимо заполнить поле «Email отправителя»." ], "checkbox": [ "Необходимо отметить чекбокс или заполнить комментарий" ], "comment": [ "Необходимо отметить чекбокс или заполнить комментарий" ], "code": 400, "title": "Bad Request", "message": "Bad Request" }

В случае успеха возвращается присвоенный номер сообщения

1 2 3 { "message": "1" }

 

4. Отправка сообщения об ошибке с каталога

Для отправка сообщения об ошибке с каталога необходимо вызвать POST запрос на адрес https://catalog.raec.su/api/errorMessage/catalog.

Все параметры должны быть переданы в массиве data.

Полный перечень возможных параметров.

Параметр

Описание

Возможные значения

Параметр

Описание

Возможные значения

sender_fio

ФИО отправителя

string

sender_phone

Телефон отправителя

string

sender_email

Email отправителя

string

section_catalog

Раздел каталога

string

subsection_catalog

Подраздел каталога

string

checkbox

Отмеченные чекбоксы. Массив строковых значений с названиями атрибутов товаров или ошибками. Рекомендуемые значения:

  • Класс ETIM

  • Тип изделия

  • Некорректный аналог

  • Изображение

  • Отсутствует новинка поставщика

  • Проблема с присвоением RAEC ID

  • Остатки поставщика

  • Остатки Участника

  • Цена

array [“Отсутствует новинка поставщика”,”Остатки поставщика”]

comment

Произвольный текстовый комментарий

string

page

Страница запроса (url ссылка на которой видна ошибка) или поисковый запрос

string

*Красным отмечены обязательные параметры

*Синим отмечены параметры обязательные по условию. Должен быть заполнен чекбокс(ы) ИЛИ комментарий.

 

Пример кода на PHP с использование клиента

1 2 3 4 5 6 7 8 9 10 11 12 13 $client = new RestClient('https://catalog.raec.su/api/', 'f85aa1473448577845a7094d4ab5bc22'); // используйте ваш ключ $response = $client->post('errorMessage/catalog', 'data' => [ 'sender_fio' => 'Фамилия Имя Отчество', 'sender_phone' => '+7900000000', 'sender_email' => 'mail@domain.ru', 'section_catalog' => 'Электроустановочные изделия', 'subsection_catalog' => 'Рамки, суппорты, адаптеры и декоративные элементы для ЭУИ', 'checkbox' => [“Отсутствует новинка поставщика”,”Остатки поставщика”], 'comment' => 'Бренд AAAAA' ] );

Пример запроса с использованием cURL

1 2 3 4 5 6 7 8 9 curl --location --request POST 'https://catalog.raec.su/api/errorMessage/catalog' \ --header 'API-KEY: *******************' \ --form 'data[sender_fio]="Фамилия Имя Отчество"' \ --form 'data[sender_phone]="+7900000000"' \ --form 'data[sender_email]="mail@domain.ru"' \ --form 'data[section_catalog]="Электроустановочные изделия"' \ --form 'data[checkbox][]="Отсутствует новинка поставщика"' \ --form 'data[checkbox][]="Остатки поставщика"' \ --form 'data[comment]="Бренд AAAAA"'

Пример ответа в случае ошибки, код ответа - 400

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 { "sender_fio": [ "Необходимо заполнить поле «ФИО отправителя»." ], "sender_phone": [ "Необходимо заполнить поле «Телефон отправителя»." ], "sender_email": [ "Необходимо заполнить поле «Email отправителя»." ], "checkbox": [ "Необходимо отметить чекбокс или заполнить комментарий" ], "comment": [ "Необходимо отметить чекбокс или заполнить комментарий" ], "section_catalog": [ "Необходимо заполнить поле «Раздел каталога»." ], "code": 400, "title": "Bad Request", "message": "Bad Request" }

В случае успеха возвращается присвоенный номер сообщения

1 2 3 { "message": "2" }

 

5. Support

По любым вопросам, связанными с API или работой Базы RAEC, вы можете связаться со специалистами по email support@raec.su