API

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

API ачкычтар

Ачкычты жетекчи «Интеграциялар» бөлүмүндөгү «API ачкычтар» өтмөгүндө чыгарат. Сурам ачкычты жана компанияны баш сапта берет, ар бир чакыруу журналга жазылат.

API_KEY: <ачкыч> · CompanyId: <компаниянын id>
  • Ачкычтын мөөнөтү 1, 6 же 12 ай, төлөм A3.ID аркылуу
  • Ачкыч чыгарылганда бир гана жолу көрсөтүлөт
  • Ачкыч ачыкка чыгып калса, кайра чыгаруу
  • Ачкыч боюнча ар бир сурамдын журналы
  • Түшүнүктүү иштетүү үчүн «КОД: билдирүү» түрүндөгү каталар

Негизги сурамдар

API тамырынан даректер, программа жана компания id коюлган curl, JavaScript жана PHP мисалдары колдонмонун «Туташуу» бөлүмүндө бар.

Берилгендик программалары

СурамМаксаты
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Каражат чыгарууга өтүнмө түзүү

Вебхуктар

CRM, кампа же аналитика окуялар тууралуу график боюнча эмес, дароо билиши үчүн A3.Marketing аларды системаңыздын дарегине жөнөтөт.

  • marketing.lead.createdЛид пайда болду, анын ичинде таратуунун трекинг-шилтемеси боюнча
  • marketing.lettering.completedТаратуу аяктады, жеткирүү статистикасы даяр
  • marketing.unsubscribe.recordedБайланыш каналдагы таратуулардан баш тартты
  • marketing.website.downКомпаниянын сайты жооп бербей калды
  • marketing.seo.report.readyАвтопарсингдин SEO-отчёту сакталды

Сайт үчүн скрипт

Кичине скрипт ?ref= шилтемесиндеги кодду 90 күнгө эстеп калат. Сатып алууда сайт сакталган кодду алып, конверсияны жөнөтөт, сатып алуучу бир жумадан кийин кайтып келсе да.

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

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

Бардык методдор, параметрлер жана ката коддору API интерактивдүү документациясында сүрөттөлгөн. Колдонмодо иштөө боюнча нускамалар A3.Solutions викисинде чогултулган.

Берилгендикти кассаңызга туташтыралыбы?

Кассаңыз, сайтыңыз жана CRM кандай экенин айтып бериңиз. Кайсы сурамдар керек экенин айтып, туташууну иштеп чыгуучуңуз менен бирге текшеребиз.