Konfiguration och användning

Konfiguration och användning

Den här vägledningen beskriver vad som måste finnas på plats för att börja använda Order Drop API – behörigheter, API-användare och inställningar – och skillnaden mellan att använda API:et via en färdig integration kontra att ansluta ett externt system direkt till det.

INNEHÅLLSFÖRTECKNING

• Åtkomststyrning och behörigheter
• Förutsättningar
• Skapa API-användare
• Konfigurera inställningar
• Användning via färdig integration
• Användning från externt system (direkt anslutning)

Åtkomststyrning och behörigheter

Vanliga användare och kunder har inte direkt åtkomst till Order Drop API. Åtkomst kräver en API-användare med åtkomstnyckel. Order skapade via API:et är synliga för alla som har åtkomst till ordervyn – de hanteras som vanliga order.

Förutsättningar

Innan orderimporten fungerar måste följande finnas på plats:

• Licens: ingen – Order Drop API är en del av grundsystemet
  
  
• API-användare med åtkomstnyckel (skapas av systemadministratören)
  
  
• Produkter registrerade i Telaris med rätt produktnummer eller SKU. Rader utan träff läggs till utan produktkoppling (om inte «Avvisa saknad produkt» är aktiverad)
  
  
• Kunddata: den inskickade datan måste innehålla antingen kundens e-postadress eller kundnummer med ifyllt värde. Andra identifierare (organisationsnummer, internt kund-ID, Tripletex-ID) kan användas för själva uppslaget, men är inte tillräckligt ensamma – förfrågan avvisas innan uppslaget sker

Skapa API-användare

En API-användare skapas av systemadministratören och får en åtkomstnyckel som används för autentisering i alla API-anrop:

1. Kontakta systemadministratören för att skapa en API-användare
2. Ta emot åtkomstnyckeln
3. Ange nyckeln till den som ska integrera – antingen ett Telaris-integrationsteam eller en extern part

Åtkomstnyckeln är varaktig och behöver inte förnyas med jämna mellanrum.

Tips: Steg-för-steg-metoden för att skapa API-användaren beskrivs i artikeln «Skapa API-användare».

Konfigurera inställningar

Inställningarna för Order Drop API konfigureras via Telaris support/projekt Det finns inga dedikerade fält – inställningarna läggs in som nyckel/värde-par:

• Avvisa saknad kund– aktivera om endast befintliga kunder ska få order importerade
  
  
• Avvisa saknad produkt – aktivera om alla produkter i orderraderna måste finnas i Telaris
  
  
• Uppdatera leveransadress – aktivera för att lagra leveransadressen som ett eget adressobjekt i stället för fritext
  
  
• Aviseringsmottagare – ange en e-postadress för att ta emot avisering vid nya order
  
  

Till info: En fullständig förklaring av vad varje inställning gör finns i artikeln «Så fungerar orderimporten».

Användning via färdig integration

Order Drop API används normalt inte direkt av slutanvändare, utan av integrationer. När en integration är uppsatt flödar order automatiskt in i Telaris:

• WooCommerce-integrationen – konfigureras som integrationsapp under Administration → Integrationer
• Telaris Connect – tar emot order från anslutna Telaris-instanser
  
  

För färdigbyggda integrationer är allt API-arbete redan hanterat. Konfigurationen är då det som står i den aktuella integrationens egen artikel.

Användning från externt system (direkt anslutning)

Externa parter – kunder, partner eller tredjepartsutvecklare – kan ansluta direkt till Order Drop API. Det är relevant när:

• Kunden har ett eget ordersystem, ERP eller webbutik utan en färdig Telaris-integration
• En partner eller leverantör vill skicka order automatiskt
• En utvecklare bygger en egendefinierad integration
  
  

Så kommer man i gång (Telaris sida):

1. Systemadministratören skapar en API-användare och delar åtkomstnyckeln med den externa parten
2. Den externa parten tar emot Telaris API-dokumentation som beskriver dataformat och autentisering
3. Den externa parten bygger integrationen i sitt system – typiskt genom att skicka orderdata till API:et via ett standard-HTTP-anrop
4. Testa med en provorder och verifiera att den skapas korrekt i Telaris
5. Sätt i produktion
   
   

OBS: Telaris sida omfattar att skapa API-användaren, konfigurera inställningar, dela dokumentation och verifiera att mottagningen fungerar, samt en kort genomgång av API:et. Testning och felsökning där Telaris är involverad tillkommer och varierar med den externa partens kompetens. Den externa partens eget utvecklingsarbete – att bygga, formatera, testa och felsöka på sin sida – ligger utanför Telaris ansvarsområde.

Till info: API-dokumentationen är teknisk och avsedd för utvecklare. Onboarding- och supportpersonal behöver normalt inte läsa den – det räcker att veta att den finns och kan delas med den externa parten.