REST API

REST API: din Upsellr-katalog, styrd från dina egna verktyg.

Skapa produkter från ditt ERP, ladda upp dina leverantörsfiler, starta berikning och generering och läs sedan innehållet som skrivits för varje kanal och varje språk. Ett dokumenterat REST API, med nycklar med begränsade behörigheter.

Kategori
API
Riktning
Läsning och skrivning
Version
REST v2, OpenAPI-specifikation
Nycklar
Upp till 10 per organisation, valfria behörigheter
Språk
Etiketter på franska, engelska, spanska och tyska
Autentisering
API-nyckel i Authorization-headern
Planer
Planen Enterprise
Utgivare
Upsellr

01Vad API:et gör

Upsellr, från dina egna verktyg.

  1. 01

    Skapa dina produkter i omgångar

    Skicka upp till 100 produkter per anrop. Upsellr känner igen dem på EAN, SKU eller tillverkarens artikelnummer och märke: en redan känd produkt dupliceras inte, den får en ny version när ett värde ändras.

  2. 02

    Läs din master data

    Fält, värdelistor, kategorier och mallar: det som strukturerar din katalog kan läsas via API:et, med etiketter på ditt språk.

  3. 03

    Ladda upp dina leverantörsfiler

    Lägg dina kalkylblad och PDF:er i Upsellrs filbibliotek: upp till 10 MiB i en uppladdning, större filer i flera delar.

  4. 04

    Starta berikning och generering

    Starta en körning på ett urval, en sökning eller hela katalogen, upp till 50 000 produkter: Lily berikar master data, Max skriver sidorna för dina kanaler, eller så körs ett av dina arbetsflöden.

  5. 05

    Läs det genererade innehållet

    Varje produkt returnerar sin master data, sina importerade värden och sitt genererade innehåll, sorterat per kanal och språk.

  6. 06

    Följ dina körningar

    En körning kan följas via API:et eller via webhook: slutförd, misslyckad eller stoppad, ditt verktyg får besked.

02Kom igång

Din första förfrågan på några minuter.

  1. 01

    Öppna organisationens inställningar

    Avsnittet API och webhooks, förbehållet ägare och administratörer.

  2. 02

    Skapa en nyckel

    Välj behörigheter: endast läsning, läsning och skrivning, eller full åtkomst. Lägg till ett utgångsdatum och tillåtna IP-adresser om du vill.

  3. 03

    Koppla den till ditt verktyg

    Den skickas i Authorization-headern vid varje anrop.

  4. 04

    Anropa API:et från din server

    Det anropas inte från en webbläsare: dina nycklar stannar på serversidan.

  5. 05

    Följ dina körningar

    Via API:et, eller med en webhook som meddelar dig när varje körning är klar.

03Resurser

Vad API:et kan läsa och skriva.

ResursLäsningSkrivning
ProdukterJaJa
EAN, SKU och tillverkarens artikelnummerJaJa
Värden i master dataJaJa
Genererat innehåll, per kanal och språkJaNej
Fält och listor i master dataJaNej
KällfilerJaJaUpp till 10 MiB, eller i flera delar
Körningar för berikning och genereringJaJa
Pris

Kompatibilitet och krav

  • Planen Enterprise
  • En ägar- eller administratörsroll för att skapa nycklar
  • En server som anropar API:et, aldrig en webbläsare
  • Headern Authorization: Bearer vid varje anrop
  • Tips: en nyckel per verktyg, med bara de behörigheter som behövs

Du har kontrollen

Nycklar under kontroll.

  • Behörigheter per nyckel: endast läsning, läsning och skrivning, eller full åtkomst
  • Ett utgångsdatum och tillåtna IP-adresser, om du vill
  • Anropsgränser per organisation, som signaleras när de överskrids
  • Ett förfrågnings-ID i varje svar, för supporten

04Frågor

Frågor om Upsellrs API.

Ingår API:et i min plan?

Det är förbehållet planen Enterprise. I övriga planer är avsnittet API och webhooks synligt men låst.

Var hittar jag dokumentationen?

API-referensen genereras från dess OpenAPI-specifikation, med exempel i curl, JavaScript, Python och Ruby.

Vilka anropsgränser gäller?

Per organisation: 200 läsningar och 60 skrivningar per minut, och 20 per minut för tunga operationer, som att skapa produkter, ladda upp filer och starta körningar. Därutöver svarar API:et 429 med den tid du behöver vänta.

Kan jag ändra eller ta bort en produkt via API:et?

Inte än. Du skapar produkter, och om du skickar en befintlig produkt igen får den en ny version när ett värde ändras. Ändringar och borttagningar görs i Upsellr.

Hur undviker jag dubbletter?

Upsellr känner igen varje produkt på dess EAN, dess SKU, eller dess tillverkarens artikelnummer och märke: att skicka samma produkt igen skapar ingen dubblett.

Kan jag starta berikningen från mitt verktyg?

Ja. Starta berikning, generering, båda, eller ett av dina arbetsflöden, på ett urval, en sökning eller hela katalogen, upp till 50 000 produkter per körning.

Hur vet jag att en körning är klar?

Fråga efter körningen via API:et, eller ta emot en webhook när den slutförs, misslyckas eller stoppas.

Finns det ett SDK?

Inte just nu: API:et är ett vanligt REST API, och referensen ger exempel som är klara att kopiera.

Din nästa produkt
förtjänar mer än kopiera och klistra.

Ge ditt AI-team de första produkterna att arbeta med.