API - Правила генерации API запроса

Для упрощения интеграции данных из Competera в ERP пользователя, существует простой и удобный способ получения всего объема данных при помощи API запроса. 

• Competera предоставляет доступ к детальным инструкциям по формированию API запроса, зарегистрированным пользователям. 
• API метод передачи данных отлично подойдет для интеграции с вашей учетной системой ERP и позволит забирать данные автоматически, в большом объеме и удобном формате.

Инструкции для формирования API запроса

Вы можете ознакомится с документацией API в отделе помощи в кабинете. 

https://dashboard.competera.net/apidoc/ (не забудьте войти в личный кабинет перед просмотром).

Основные параметры формирования API запроса

1. API ключ
2. ID компании 
3. Имя пользователя (e-mail)

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

ID компании можно узнать из ссылки в командной строке браузера

Принцип формирования API запроса

Формируем базовую ссылку запроса: 

- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/

Задаем необходимый формат отчета: 

- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/comparison_by_products/?

- https://dashboard.competera.net/api/v1/campaigns/campaign_id/categories/

Задаем формат выгрузки и лимит товаров (json/excel):   

- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/comparison_by_products/?format=json&username=john.doe@mail.com&api_key=c2a1e8722fdr334f776ae000f123456425da1b6f1&limit=100

Задаем параметры доступа пользователя:

- https://dashboard.competera.net/api/v1/campaigns/campaign_id/reports/comparison_by_products/?format=json&username=john.doe@mail.com&api_key=c2a1e8722fdr334f776ae000f123456425da1b6f1&limit=0

Пример полученных данных в формате JSON по категориям пользователя

Пример получения данных по товарной позиции 

Пример получения данных по наличию цен у конкурентов

Принцип формирования API запроса с применением фильтров

Используя фильтры состояний ваших товарных позиций, а также сопоставленных товаров конкурентов, пользователь может добавить к базовому API запросу определенные фасеты. Больше возможностей использования различных фильтров доступно в API docs. 

&availability=yes  &targets_availability=all-yes  &format=excel   

Если у вас возникнут дополнительные вопросы, вы всегда можете задать их, написав на support@competera.net