BeX® Rest API underlättar för utvecklare och integratörer
BeX® API ger möjlighet att hantera merparten av den data som finns tillgängligt i BeX® Online. Data kan hämtas, skapas, förändras och bokföras på samma sätt som man gör i gränssnittet. API-nycklar sätts upp inne i BeX Onlines administrationsmeny där även behörighet för API-nyckeln bestäms. BeX API använder Basic Authentication för autentiering. Det medför att ett användarnamn och ett lösenord iskickas med i huvudet på ett anrop som autentiering.
BeX Headless Api ger möjlighet att bygga en flexibel front end e-handel utan att dubbellagra data. All data för e-handelsbutiken finns i BeX Distributed Headless Retail som finns tillgänglig i Microsoft Azure datacenter runt om i världen. BeX Distributed Headless Retail består av Microsoft Cosmos DB, Frontdoor och cashe för snabb och säker tillgång till data.
BeX® API består av föjande delar:
- Certificate: Här hanteras olika typer av värdebevis som bonus, presentkort, tillgodokvitton och handpenningar. Värdebevis kan hämtas, kontrolleras och reserveras.
- Comment: Olika typer av kommentarer för kunder, artiklar, order mm hanteras.
- Customer: Hämtar, uppdaterar och skapar kunder.
- Invoicing: Hämtar bokförda fakturor och kreditnotor.
- Order: Här kan order och betalningar skapas och makuleras samt levererade odrar hämtas med tracking.
- Orderfullfillment: Denna är till för att externa lagersystem skall kunna hämta, låsa, uppdatera och leverera order.
- Product: Skapar, uppdaterar och hämtar produkter, produktgrupper, priser och annan produktdata.
- Purchase: Hämtar, skapar och uppdaterar inköpsorder.
- Purchase Return: Hämtar, skapar och uppdaterar inköpsreturer.
- SalesReport: Hämtar försäljningsstatistik för kunder och butiker.
- SalesReturn: Hämtar, skapar, uppdaterar och bokför försäljningsreturer samt skapar bytesorder och gör återbetalning.
- ShipmentParcel: Hämtar, skapar och uppdaterar paket samt skriver ut paketlappar.
- ShopGoCampaign: Hämtar aktuella kampanjer.
- ShopGoX: Används för att skapa e-handel och extern POS med CMS.
Metodbeskrivningar och testmöjligheter hittas i BeX API-dokumentation
BeX Headless Api består av följande delar:
- Cart: Här skapas, hämtas, ändras och fullföljs varukorgen.
- External system: Här hämtas och kontrolleras data i externt system, ex värdebevis.
- Product: Hämtar och hanterar produktdata och kampanjer.
- Stock: Hämtar och hanterar tillgängligt lager.
- Webhook: Överför data till annat system/databas, ex order och kunddata till BeX Online.
Metodbeskrivningar och testmöjligheter hittas i BeX Headless API dokumentation