Dokumentacja API

API-first: każdy moduł udostępnia swoje obiekty przez REST i webhooki.

Commerce Revenue Ecosystem jest zbudowany tak, że moduły rozmawiają ze sobą przez te same interfejsy, które udostępniamy Tobie. Poniżej zarys zakresu: obiekty, operacje i zdarzenia. Pełną dokumentację techniczną, środowisko testowe i klucze dostajesz po uruchomieniu konta.

Zasady

Cztery rzeczy, które obowiązują w każdej integracji.

Te same zasady, na których działa warstwa integracyjna z ERP, obowiązują w API dla Twoich systemów i partnerów.

Klucze z uprawnieniami

Klucz per integracja z zakresem odczytu i zapisu per obiekt. Rotacja i dziennik wywołań.

Webhooki podpisane i ponawiane

Zdarzenia z podpisem, ponowienia przy braku odpowiedzi, podgląd i ponowne wysłanie z dziennika.

Limity i monitoring

Limity wywołań per klucz, status i opóźnienia na tym samym ekranie, co integracje z ERP.

Źródło prawdy

Cena, stan i limit zawsze z ERP; produkt z PIM; kontakt z CRM. Zapis przez API respektuje te same reguły.

Zakres

Obiekty i zdarzenia per moduł.

Zarys, nie pełna specyfikacja. Pola, filtry, paginacja i przykłady są w dokumentacji technicznej dostępnej po uruchomieniu konta. Zakres może się różnić per moduł i wersję.

Zobacz warstwę integracyjną
API · zarys zakresu · REST + webhooki
ObiektModułOperacjeWebhooki
Klienci i kontaktyCRModczyt, zapisklient utworzony, zmieniony, scalony
Produkty, atrybuty, mediaPIModczyt, zapis, importprodukt opublikowany, luka wykryta
Ceny, stany, limityIntegracje ERP / WMSodczyt (źródło: ERP)zmiana stanu, zmiana cennika
Zamówienia i dostawyPlatforma B2B · Realizacjaodczyt, zapiszamówienie, wysłane, doręczone, opóźnienie
OfertyOfertowanieodczyt, zapiswysłana, otwarta, zaakceptowana, wygasła
Zgłoszenia i zwrotyObsługa klientaodczyt, zapisutworzone, zamknięte, po SLA
Sygnały i działaniaCommerce Intelligence · Revenue Pulseodczytsygnał utworzony, decyzja, wynik Attributed
Rytm i ryzyko odpływuRetentionodczytklient poza rytmem, wrócił, utracony
REST · JSONImport / eksport XLS, CSVEDI i punch-out per klientPełna dokumentacja po uruchomieniu konta

Dla kogo

Trzy typowe integracje przez API.

Większość klientów nie potrzebuje API, bo moduły rozmawiają ze sobą same, a ERP jest podłączony przez warstwę integracyjną. API przydaje się, gdy masz własne systemy albo partnerów.

BI i hurtownia danych

Odczyt zamówień, ofert, sygnałów i wyników do własnych raportów. Liczby z etykietą Measured, Estimated, Attributed.

odczyt
Systemy produkcji i planowania

Zamówienia i terminy w obie strony: produkcja potwierdza termin, klient widzi go na koncie.

odczytzapis
Aplikacje partnerów i dealerów

Produkty, stany i ceny dealera w aplikacji partnera, zamówienia wracają do ERP przez tę samą warstwę.

odczytwebhooki