OBS: Denna guide är för handlare som skall använda en integration som redan existerar. Om ni är intresserade av att själva bli integratör, kontakta api@starweb.se så hjälper vi er vidare.
Bakgrund
När ni skall använda integrationer som har byggts av tredje part så krävs det att ni skapar API-uppgifter i Starweb, detta kan t.ex gälla
- Sharespine
- Primepenguin
- Hello Retail
- Boxnet
- Zwapgrid
Hur man skapar en API-klient
OBS: API'et är inte aktiverat som standard. Kontakta supporten så aktiverar dem det till er support@starweb.se
För att skapa en ny API-klient går ni Starweb till Inställningar>Starweb API>Hantera API-klienter
Här klickar ni på Lägg till ny klient
Ni får då tre fält att fylla i:
- Klient-id: Detta är helt valfritt, men vi rekommenderar att döpa den till sitt syfte. Om det är en Sharespine-koppling till Visma Spcs så hade ett lämpligt namn kunnat vara Visma-Spcs
- API-grupp: Här väljer ni vilken integratör ni använder er av, enligt exemplet ovan hade detta varit Sharespine
- Rättigheter: Här väljer ni vilka behörigheter integrationen skall ha, generellt sett så behöver affärssystem produkter, kategorier, kunder & ordrar, men andra, enklare integrationer kan behöva mycket mindre, t.ex endast kunder & ordrar eller produkter & kategorier. Hör er för med er integratör om ni är osäkra.
När ni har fyllt i dessa fält så kan ni klicka på spara (disketten).
Ni kommer då att få se klient-id och klienthemlighet.
Ni kan när som helst återvända till denna sidan för att se klient-id, men detta kommer att vara enda gången ni ser klienthemligheten, spara därför detta på en säker plats, vi föreslår vårt eget verktyg passwords.starweb.se där ni kan skapa engångslänkar att skicka till era integratörer.
Efter att hela denna processen är klar, mejla er integratör med följande information:
- Butiksid: Detta är er permalänk hos starweb, den ser ut så här https://minbutik.starwebserver.se
- Klient-id: Detta är fältet längst till vänster, i vårt exempel sharespine.vismaspcs
- Klienthemligthet: Detta är tredje fältet från vänster sida. Vi rekommenderar starkt att inte skicka detta i klartext, använd t.ex passwords.starweb.se för att skapa en engångslänk
Felsökning/Vanliga fel
- Ett vanligt fel är att man inte kan ansluta för att hämta t.ex er token. Detta kan då bero på att ni inte angivit gruppnyckeln som krävs för att använda den valda gruppen. En gruppnyckel är något som endast integratören av gruppen har tillgång till. Gruppnyckeln skall alltid läggas in som ett prefix till klienthemligenheten. Beroende på hur integratören byggt sin koppling så får ni kontakta dem för att ansluta.
XXXXXXXYYYYYYYYYYYYY
X är då gruppnyckeln och Y är er genererade klienthemligehet.
För mer teknisk dokumentation: https://api-docs.starweb.se/#/
----------------
