A3.Marketing ашу

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 викиінде жиналған.

API құжаттамасы Материалдар мен нұсқаулықтар

Адалдықты кассаңызға қосайық па?

Қандай касса, сайт және CRM бар екенін айтыңыз. Қандай сұраулар керек екенін айтып, қосылымды әзірлеушіңізбен бірге тексереміз.

Енгізуді талқылауAPI құжаттамасы