Открыть A3.Marketing

API

Через API сайт, касса и CRM работают с программами лояльности, промокодами и реферальными программами, а события продукта приходят в ваши системы вебхуками.

API-ключи

Ключ выпускает руководитель в разделе «Интеграции» на вкладке «API-ключи». Запрос передаёт ключ и компанию в заголовках, а каждый вызов записывается в журнал.

API_KEY: <ключ> · CompanyId: <id компании>
  • Срок ключа 1, 6 или 12 месяцев, оплата в A3.ID
  • Ключ показывается один раз при выпуске
  • Перевыпуск, если ключ скомпрометирован
  • Журнал каждого запроса по ключу
  • Ошибки в виде «КОД: сообщение» для понятной обработки

Основные запросы

Адреса от корня API, примеры на curl, JavaScript и PHP с подставленными id программы и компании есть в разделе «Подключение» приложения.

Программы лояльности

ЗапросНазначение
POST External/v1/Loyalty/CustomersЗарегистрировать покупателя в программе
GET External/v1/Loyalty/CustomerПолучить баланс и грейд покупателя
POST External/v1/Loyalty/QuoteРассчитать корзину: сколько можно списать и сколько начислится
POST External/v1/Loyalty/HoldsЗарезервировать бонусы на 30 минут до оплаты
POST External/v1/Loyalty/PurchasesПровести покупку: списать и начислить бонусы
POST External/v1/Loyalty/RefundsВернуть бонусы при возврате заказа

Промокоды

ЗапросНазначение
POST External/v1/Promocodes/ValidateПроверить код для заказа и посчитать скидку
POST External/v1/Promocodes/ApplyПрименить код к заказу
POST External/v1/Promocodes/ReleaseОсвободить код при отмене заказа

Реферальные программы

ЗапросНазначение
POST External/v1/Referral/ParticipantsЗарегистрировать участника и получить код
GET External/v1/Referral/ParticipantПолучить данные и баланс участника
POST External/v1/Referral/ConversionsЗасчитать покупку по реферальному коду
POST External/v1/Referral/Conversions/CancelОтменить конверсию при возврате
POST External/v1/Referral/WithdrawalsСоздать заявку на вывод средств

Вебхуки

A3.Marketing отправляет события на адрес вашей системы, чтобы CRM, склад или аналитика узнавали о них сразу, а не по расписанию.

  • marketing.lead.createdПоявился лид, в том числе по трекинг-ссылке рассылки
  • marketing.lettering.completedРассылка завершена, статистика доставки готова
  • marketing.unsubscribe.recordedКонтакт отписался от рассылок в канале
  • marketing.website.downСайт компании перестал отвечать
  • marketing.seo.report.readySEO-отчёт автопарсинга сохранён

Скрипт для сайта

Небольшой скрипт запоминает код из ссылки ?ref= на 90 дней. При покупке сайт берёт сохранённый код и отправляет конверсию, даже если покупатель вернулся через неделю.

Реферальные программы

Полная документация

Все методы, параметры и коды ошибок описаны в интерактивной документации API. Инструкции по работе в приложении собраны в вики A3.Solutions.

Документация API Материалы и инструкции

Подключим лояльность к вашей кассе?

Расскажите, какая у вас касса, сайт и CRM. Подскажем, какие запросы нужны, и проверим подключение вместе с вашим разработчиком.

Обсудить внедрениеДокументация API