Skapa API-uppgifter för integration

I denna artikel kommer vi att gå igenom hur du skapar en API-nyckel i din butik. API-klient eller API-uppgifter krävs när ni ska använda integrationer i plattformen som byggts av en tredje part. Detta kan t.ex gälla Sharespine, Hello Retails eller Boxnet. 

OBS: Denna artikel är aktuell för dig som har en existerande integration. Om du är intresserad av att bli integratör, kontakta api@starweb.se.

Hur du skapar en API-klient 

Starweb API är inte aktiverat som standard. Om du inte ser det i din butik kontakta support@starweb.se 

För att skapa en ny API-klient går du till Inställningar -> Starweb API. Klicka på “Hantera API-klienter”. 

Nu klickar du på “lägg till ny klient”

Nu får du tre fält att fylla i. 

• Klient-id: Här är det valfritt vad du fyller i, men vi tipsar om att döpa den relevant för sitt syfte. Om det exempelvis är en Sharespine koppling kan det vara passande att den heter Sharespine. 
• API-grupp: Här väljer du den integrationen du ska ha eller de som byggt kopplingen till er integration. 
• Rättigheter: Här väljer du de rättigheter integrationen ska ha. Generellt sätt så behöver affärssystem produkter, kategorier, kunder & ordrar, medan andra enklare integrationer kan behöva mycket mindre.  Det bästa är att kontakta integratören och se vad de behöver tillgång till. 

När dessa fält är ifyllda klickar ni på Spara-disketten till höger. 

Ni kommer du att få ett Klient-ID och en Klienthemlighet. Det är viktigt att tänka på att er klienthemlighet syns endast EN gång, så kopiera den och spara på ett säkert ställe. Ditt klient-id kommer alltid att synas.

För att sedan säkert kunna skicka er klienthemlighet till era integratörer föreslår vi att använda er av passwords.starweb.se. Här kan ni skapa engångslänkar med hemligheten till era integratörer.

Nu har du skapat din API-klient! Nu behöver du maila följande information till integratören: 

• Butiks-id: Kontakta Starweb för att få ut ditt shop-id.
• Klient-id: Det klient-id som skapats och står i fältet längst till vänster. 
• Klienthemligheten: Tredje fältet från vänster. Vi rekommenderar att inte skicka detta i klartext utan använda er av passwords.starweb.se som nämnt ovan. 

Vanliga fel 

Ett vanligt fel kan vara att man exempelvis inte kan ansluta och hämta t.ex er token. Detta kan bero på att gruppnyckeln inte angivits. En gruppnyckel har endast integratören tillgång till och ska läggas in som prefix till klienthemligheten. Beroende på hur integrationen har byggt kopplingen så ska ni kontakta dem för att ansluta.

 XXXXXXXYYYYYYYYYYYYY

X är gruppnyckeln och Y är den genererade klienthemligheten. 

För mer teknisk dokumentation, tryck här. 

----------------

Behöver du hjälp så kontakta gärna vår support
Mejl: support@starweb.se Telefon: 040 - 602 09 00