3 min läsning

Skapa en API-nyckel

  1. Installera tillägget API under Tillägg > Installera tillägg och öppna Tillägg > API.

  2. Klicka Skapa nyckel. Bocka i vilka metoder nyckeln får använda (GET, POST, PUT, DELETE) och skriv en sökväg, till exempel /articles. * betyder allt. Fler regler lägger du till med Lägg till.

  3. Fyll i Callback-url om ni vill få ett anrop när något ändras (se Till utvecklaren).

  4. Klicka Uppdatera. Nyckeln sparas först nu.

  5. Nyckeln står under rubriken API-nyckel. Lämna den till utvecklaren på ett säkert sätt.

Så fungerar nyckeln

  • Nyckeln gäller tills den tas bort och har inget utgångsdatum. Den gäller för alla lager i kontot.
  • Utan begränsningar har nyckeln full åtkomst till kontots data. Behandla den som ett lösenord.
  • Ge varje system en egen nyckel med bara det systemet behöver, till exempel bara GET på /articles för en prisfil. Sökvägen skrivs utan /v1.
  • En nyckel tar du bort med papperskorgen och sedan Uppdatera. Det går inte att ångra.
  • Avinstalleras tillägget API slutar alla nycklar att fungera.

Till utvecklaren

Dokumentationen (Swagger/OpenAPI och en sida om callbacks) är på engelska. Länken finns också på sidan API-inställningar.

Öppna API-dokumentationen
Adress
Https://capi.lagerkoll.com/v1/<resurs>, till exempel /v1/articles. Bara version v1 finns.
Format
JSON (UTF-8). Många anrop klarar även XML.
Inloggning
API-nyckeln i headern api_key och lagrets id i headern store. Det går också att logga in med en användarsession (user_id och user_token) eller med OAuth 2.1 för appar och AI-kopplingar. OAuth-anslutningar ser och återkallar användaren under Inställningar > Anslutningar.
Gräns
Högst 200 anrop per minut och lager. Över gränsen svarar API:et 429 med headern Retry-After, som anger hur många sekunder man ska vänta.
Sidindelning
Page (börjar på 0) och limit.
Resurser
Artiklar (med saldo, batch- och serienummer, lagerplatser och lagervärde), kunder, kundordrar, inköpsordrar, leverantörer, produktionsordrar, projekt, inventering, lager, fakturor, priser och prislistor, kategorier, enheter, moms, valutor, villkor, leveranssätt, dokument, bilder och rapporter.
Callbacks
Lagerkoll skickar ett POST-anrop till Callback-url för varje objekt som skapas, ändras eller tas bort. Flera adresser skiljs med kommatecken. Callbacks finns för artiklar, lager, prislistor och priser, valutor, kunder, kundordrar, leverantörer, kund- och leverantörsleveransvillkor, leveranssätt, betalningsvillkor och kostnadsställen. Vilka fält som skickas står under Callbacks i dokumentationen.

Vanliga frågor

Nyckeln fungerar inte
Uppdatera klickades aldrig, så nyckeln sparades inte. Skapa den igen och klicka Uppdatera.
Felet "Det saknas metod och sökväg för en eller flera api-nycklar"
En nyckel saknar regel. Bocka i minst en metod och ange en sökväg.
Svar 403 "Access denied"
Nyckelns regler täcker inte metoden eller sökvägen. Kontrollera att sökvägen är skriven utan /v1 och att headern store skickas med.
Svar 403 "Access denied, component not active"
Tillägget API är inte installerat, eller har avinstallerats.
Svar 429 "Too many requests"
Mer än 200 anrop per minut. Vänta så många sekunder som Retry-After anger och sprid ut anropen.
Alla artiklar kommer inte med
Listan över artiklar har parametern since. Hur den ska sättas för att få alla artiklar står i dokumentationen.
Menyn API syns inte
Tillägget är inte installerat, eller så saknar din roll behörighet. Se Förstå roller och behörigheter.