Pull API

Hämta data med autentisering från externt API direkt från Store-front

Överblick

Vendres e-handelssystem är utrustat med Vendre Pull API som ger dig möjlighet att hämta information från valfritt RestAPI.

Vendre Pull API hämtar då genom en förfrågan till det externa systemet den information som behövs i precis det tillfället som krävs för att optimera laddningstid och hastighet för kunden. Förfrågan autentiseras via Vendres back-end innan förfrågan skickas till externa systemet.

Anropen kan göras genom TWIG (innan sidan laddas) eller asynkront (efter att sidan laddas med Ajax).

Observera att generell information om produkter, kunder, priser, lager oftast alltid körs via Vendres Rest API eller via Vendre file API för att uträkningar, SEO och andra systemfunktioner kräver att informationen finns i systemet.

Vendre Pull API används för att visa data på sidan från externa källor, inte uppdatera den informationen som finns i Vendres databas med undantag för livedata för Priser och lager som kan uppdatera Vendres databas.

Exempel på användning

Nedan följer en lista på områden där Pull API ofta används:

• Anrop som uppdaterar Vendres databas
  
  • Liveanrop för priser
  • Liveanrop för lagersaldo / status
• Anrop som inte uppdaterar Vendres databas
  Dessa anrop visar informationen för användaren från det externa systemet men lagras aldrig hos Vendre
  
  • Orderhistorik
  • Fakturahistorik
  • Restnoterade produkter
  • Orderstopp
  • Information från kundklubb
  • Uppdatering av kundinformation på mitt konto mot externa system
  • Hämta innehållsförteckning från externt system på produktsida
  • Kreditlimitskontroll i kassan 

Har ni ett affärssystem med ett öppet API?

Då kan denna funktionalitet hjälpa er att uppdatera er butiks priser on-demand genom att hämta in priserna från ert API och lagra de senaste uppgifterna hos Vendre för att visa i butiken

Krav för användning

• En publikt tillgänglig endpoint
• Stöd för att läsa av headern innehållandes till exempel en bearer token eller en api-nyckel
• Kunna läsa av en body innehållandes JSON- eller XML-data som en sträng
• Kunna returnera en body innehållandes JSON- eller XML-data som en sträng formaterad enligt våra krav

Förstudie / Business case

Vendre rekommenderar alltid att göra en förstudie / business case inför att börja använda Vendre Pull API för att säkerställa att den externa tjänst där Vendre ska hämta data är införstådda med vad de ska kunna presentera / generera i sina API:er för att Vendre Pull Api ska fungera. Rekommenderat från Vendre är att lägga 1 - 2 dagar på den förstudien som då också bör inkludera vilka anrop som ska göras inom ramen för projektet.

Förslag på förstudieupplägg:

• Säkerställ
  • Lista på samtliga API-anrop
  • Autentisering
  • Beräkna vilken typ av belastning som ska gå via API-anropen och att det externa systemet hanterar den kraften
  • Vilka fält behövs skickas med från Vendre till externt system och kan dessa fält skickas av Vendre?
  • Hur ska Pull-API implementeras i store-front?

Butiksmall

För att kunna använda er av denna funktionalitet kommer eran butiksmall med stor sannolikhet komma att behöva anpassas då detta kräver ytterligare funktionalitet.

Önskar ni denna funktionalitet?

Kontakta ps@vendre.se för mer information.