ConnectWiz + API и вебхукови

Интеграција во функција

API-то што го продаваме е API-то што го користиме

Целата платформа е опишана во еден OpenAPI договор од кој се генерираат и нашиот панел и нашата мобилна апликација – без скриени крајни точки, без документација што заостанува зад кодот. Врз него: Commerce API клучеви со ограничени дозволи, заштитени тригери од вебхукови и текови што ги повикуваат вашите системи.

Еден OpenAPI договор API клучеви со ограничени дозволи Вебхукови проверени со HMAC
API и вебхукови × ConnectWiz
Содржината е податок, никогаш наредба
Клуч со дозволи: читање каталог · запишување нарачки
Вебхук → проверен со HMAC → тек стартува
REST чекор во текот го повикува вашето API
1
Меродавен OpenAPI договор – истата датотека од која се генерираат нашиот панел и нашите мобилни апликации
3
Commerce дозволи – читање каталог, читање нарачки, запишување нарачки – доделени по клуч
100
Најмногу редови по читање, ограничено на серверот – параметарот limit се проверува, никогаш не му се верува слепо
50
Ставки по нарачка преку API – објавена граница, а не граница што ќе ја откриете сами

За програмери

Што точно прави

Еден меродавен договор

Еден единствен OpenAPI 3 документ ја опишува платформата; од него се генерираат и нашите сопствени TypeScript клиенти – документацијата не може да се оддалечи од реалноста, затоа што реалноста е изградена од документацијата.

Commerce API клучеви

Клучеви што ги издава самиот работен простор, со изречни дозволи – читање каталог, читање нарачки, запишување нарачки – го придвижуваат вашиот сопствен излог или апликација врз истиот систем за нарачки, а цените секогаш се пресметуваат на серверот.

Дојдовни вебхукови, заштитени

Секој тригер од вебхук во текот има своја URL-адреса и тајна, HMAC проверка врз суровото тело на барањето и заштита од повторно испраќање. Содржината може да именува лице; никогаш не може да управува со внатрешноста на текот.

Појдовно, преку текови

REST чекорот ги повикува вашите системи точно во моментите што ќе ги нацртате на платното – нарачката е направена, согласноста е дадена, терминот е закажан.

Техничка страна

Нашите ставови за дизајнот на API, кажани отворено

Цените никогаш не доаѓаат од клиентот

Барањето за нарачка кажува само што и колку – името и цената се читаат од каталогот во тој момент, на серверот, и се запишуваат во ставката како моментална слика. Изменето барање не може да измисли попуст.

Можностите пред повиците

Секоја интеграција објавува договор за своите можности – може ли да пронајде клиент по телефон, да ги наведе нарачките на гостите, да создава нарачки? – а повик преку објавено „не“ веднаш фрла грешка, наместо да пропадне некаде длабоко.

Грешки што значат нешто

Транспортниот слој разликува „неовластено“ од „услугата не работи“ – па „продавницата е недостапна“ никогаш не се прикажува како „овој клиент никогаш ништо не купил“. Именуваните грешки се разликата меѓу API и игра на погодување.

Вебхукови отпорни на повторување

Секој дојдовен настан пред обработката резервира единствен клуч во евиденцијата за идемпотентност – повторената или реемитуваната испорака запира на ниво на базата на податоци, а не во вашата автоматизација.

Клучевите се хеширани, тајните ограничени

API клучевите се чуваат како хешови, а на влезот може да се разрешат само хешот и дозволите – протечен ред од базата не именува ниту еден работен простор и не отклучува ништо надвор од своите дозволи.

Нацртите и потврдите се изречни

Создавањето нарачка бара изречен параметар confirm – јавното API стандардно создава потврдени нарачки, а тековите во панелот можат да подготват нацрти – па „дали е ова вистинско?“ е поле, а не договорна пракса.

Поставување

Како се поврзува

01

Издадете клуч

Создадете Commerce API клуч со ограничени дозволи во панелот; исто толку лесно можете и да го поништите.

02

Поврзете вебхук

Создадете тек со тригер од вебхук; потпишувајте ги барањата со неговата тајна.

03

Повикајте нанадвор

Додајте REST чекори таму каде што вашите системи треба да бидат известени.

Подобро заедно

Со што се комбинира

Flows

Тригерите од вебхукови стартуваат текови; REST чекорите ги повикуваат вашите системи во моментите што ќе ги нацртате – дојдовната и појдовната автоматизација делат едно платно.

Commerce

Нашиот систем за каталог и нарачки што стои зад API-то е истиот што го користат продавницата во разговор и AI – една вистина за нарачките, четири врати.

Ваш сопствен излог

Тимовите веќе денес водат headless излози врз Commerce API – тоа е патот што искрено го препорачува нашата страница за Shopify додека се гради нативниот конектор.

Безбедност и гаранции

Досадните гаранции

HMAC врз суровото тело

Проверката на вебхукот го потпишува суровото тело на барањето со тајна својствена за секој тригер и споредува во константно време – парсирањето доаѓа дури по доказот.

Содржината е податок, никогаш наредба

Содржината на вебхукот може да упатува на лице; никогаш не може да управува со внатрешноста на текот, да ги препишува инструкциите за AI или да повикува алатки. Границата меѓу податоци и инструкции е вградена во архитектурата, а не зависи од однесувањето.

Ограничување на бројот барања на секоја врата

Јавните крајни точки имаат стандардно ограничување на бројот барања, а границите за читање се поставени на серверот – клиентот што се однесува лошо си штети самиот на себе, а не на платформата.

Ситни букви без разубавување

Границите, кажани отворено

Сѐ уште нема поток на сите настани

Општ вебхук фид за претплата на сите настани не е изграден – појдовните настани засега се случуваат преку чекори во текови. Го пишуваме тука, за ниту еден продажен разговор да не мора да наведува на поинаков заклучок.

Ограничени читања, намерно

Читањата враќаат до 100 редови со курсор за следната страница – API-то е изградено за оперативна интеграција, а не за масовен извоз. За масовни потреби се разговара, не се бараат дупки во правилата.

Прашања за API и вебхукови

Одговори без заобиколување

Повеќе одговори има во делот Често поставувани прашања, или прашајте нѐ директно.

Платформата е опишана во еден OpenAPI 3 договор – истата датотека од која веб-панелот и мобилната апликација ги генерираат своите типови. Она со кое вие се интегрирате е она врз кое работиме ние.

Посебна тајна за секој тригер, HMAC проверка врз суровото тело и заштита од повторно испраќање преку евиденција за идемпотентност. И по правило, содржината е податок: може да упатува на лице, никогаш да ѝ наредува на автоматизацијата.

Преку REST чекори во текови, што се активираат во моментите што ќе ги изберете на платното. Општ појдовен вебхук фид е на планот за развој и намерно не го ветуваме додека не биде испорачан.

Да – читањето од каталогот и запишувањето нарачки се поддржаниот пат, со цени што се пресметуваат на серверот и клучеви со ограничени дозволи што можете да ги поништите за секој канал посебно. Границите од 50 ставки и 100 редови ги објавуваме за да дизајнирате според нив, наместо да се сопнете на нив.

Испораките кај нас се идемпотентни – евиденцијата препознава повторување и го отфрла, па вашите системи можат безбедно да пробаат повторно. Појдовните REST чекори од тековите имаат сопствено правило за повторни обиди, а неуспесите се прикажуваат во извршувањето на текот.

Подобро искрено поврзано отколку гласно рекламирано.

Секоја интеграција овде е опишана според тоа што навистина прави – вклучувајќи ги насоката, сопственоста и ограничувањата.