Знакомство с API

У нас несколько API. Узнайте, какой API лучше использовать для ваших задач.

Введение

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


Javascript API

На свой сайт вы устанавливаете скрипт Aplaut, который отображает

формы отзыва, вопроса-ответа и комментария, а также запрашивает и отображает виджеты.

Используя Javascript API вы можете более гибко настроить отображение виджетов, а также подписаться на различные события (открытие формы, просмотр виджета, …). Подробнее в документации.


Widgets API

Используется для получения виджетов на клиентских устройствах, таких как браузеры, мобильные приложения и интернет-киоски. Особенности: ответы кэшируются, лимитов по запросам нет, публичный ключ. Подробнее в документации.


Submissions API

Используется для сабмита UGC контента (отзывы, вопросы, фото, комментарии и т.д.) с клиентских устройств. Особенности: есть лимиты по запросам, публичный ключ. Подробнее в документации.


Platform API*

API общего назначения для запросов к ресурсам платформы, таким как Заказы, Товары, Клиенты, Отзывы и т.д. Обладает широкими возможностями, поэтому доступ должен осуществляться только из защищенных сетей. Особенности: приватный ключ, лимит по запросам. Подробнее в документации.


*не предназначено для использования на клиентских устройствах, таких как мобильные приложения или браузеры, а также для работы через шлюзы: мобильный клиент -> шлюз (микросервис) -> Platform API


Кейсы использования

Задача

Используйте

Встроить отзывы в сайт для SEO

Widgets API

Сделать свой виджет отзывов, получая данные на лету

Widgets API

Обновлять рейтинг товаров внутри CMS

Widgets API или Platform API
в зависимости от частоты обновления рейтинга

В моб. приложении реализовать отображение и сабмит отзывов через ваши родные формы

Widgets API и Submissions API

Сделать свою собственную форму для добавления отзыва на сайте

Submissions API

Загрузить много отзывов в платформу Aplaut

Platform API

Периодически полностью синхронизировать отзывы со своим бэкендом

Platform API (ресурс export tasks)

В Google Analytics отправлять события формы отзывов (открытие, отправка, итд.)

Javascript API




👆 На этом пока всё