REST API

REST API: dit Upsellr-katalog, styret fra dine egne værktøjer.

Opret produkter fra dit ERP, upload dine leverandørfiler, start berigelse og generering, og læs derefter indholdet, der er skrevet til hver kanal og hvert sprog. Et dokumenteret REST API, med nøgler med begrænsede rettigheder.

Kategori
API
Retning
Læsning og skrivning
Version
REST v2, OpenAPI-specifikation
Nøgler
Op til 10 pr. organisation, rettigheder efter eget valg
Sprog
Etiketter på fransk, engelsk, spansk og tysk
Godkendelse
API-nøgle i Authorization-headeren
Planer
Enterprise-planen
Udgiver
Upsellr

01Det kan API’et

Upsellr, fra dine egne værktøjer.

  1. 01

    Opret dine produkter i batches

    Send op til 100 produkter pr. kald. Upsellr genkender dem på EAN, SKU eller producentens varenummer og mærke: et kendt produkt dubleres ikke, det får en ny version, når en værdi ændres.

  2. 02

    Læs din master data

    Felter, værdilister, kategorier og skabeloner: det, der strukturerer dit katalog, kan læses via API’et, med etiketter på dit sprog.

  3. 03

    Upload dine leverandørfiler

    Læg dine regneark og PDF’er i Upsellrs filbibliotek: op til 10 MiB i én upload, større filer i flere dele.

  4. 04

    Start berigelse og generering

    Start en kørsel på et udvalg, en søgning eller hele kataloget, op til 50.000 produkter: Lily beriger master data, Max skriver siderne til dine kanaler, eller et af dine workflows køres.

  5. 05

    Læs det genererede indhold

    Hvert produkt returnerer sin master data, sine importerede værdier og sit genererede indhold, sorteret efter kanal og sprog.

  6. 06

    Følg dine kørsler

    En kørsel kan følges via API’et eller via webhook: fuldført, mislykket eller stoppet, dit værktøj får besked.

02Kom i gang

Din første forespørgsel på få minutter.

  1. 01

    Åbn organisationens indstillinger

    Sektionen API og webhooks, forbeholdt ejere og administratorer.

  2. 02

    Opret en nøgle

    Vælg dens rettigheder: kun læsning, læsning og skrivning, eller fuld adgang. Tilføj en udløbsdato og tilladte IP-adresser, hvis du vil.

  3. 03

    Tilslut den til dit værktøj

    Den sendes i Authorization-headeren ved hvert kald.

  4. 04

    Kald API’et fra din server

    Det kaldes ikke fra en browser: dine nøgler forbliver på serveren.

  5. 05

    Følg dine kørsler

    Via API’et, eller med en webhook, der giver dig besked, når hver kørsel er slut.

03Ressourcer

Det kan API’et læse og skrive.

RessourceLæsningSkrivning
ProdukterJaJa
EAN, SKU og producentens varenummerJaJa
Værdier i master dataJaJa
Genereret indhold, pr. kanal og sprogJaNej
Felter og lister i master dataJaNej
KildefilerJaJaOp til 10 MiB, eller i flere dele
Kørsler for berigelse og genereringJaJa
Pris

Kompatibilitet og krav

  • Enterprise-planen
  • En ejer- eller administratorrolle for at oprette nøgler
  • En server til at kalde API’et, aldrig en browser
  • Headeren Authorization: Bearer ved hvert kald
  • Tip: én nøgle pr. værktøj, kun med de nødvendige rettigheder

Du har kontrollen

Nøgler under kontrol.

  • Rettigheder pr. nøgle: kun læsning, læsning og skrivning, eller fuld adgang
  • En udløbsdato og tilladte IP-adresser, hvis du vil
  • Kaldgrænser pr. organisation, som meldes, når de overskrides
  • Et forespørgsels-ID i hvert svar, til supporten

04Spørgsmål

Spørgsmål om Upsellrs API.

Er API’et inkluderet i min plan?

Det er forbeholdt Enterprise-planen. På de øvrige planer er sektionen API og webhooks synlig, men låst.

Hvor finder jeg dokumentationen?

API-referencen genereres ud fra dens OpenAPI-specifikation, med eksempler i curl, JavaScript, Python og Ruby.

Hvilke kaldgrænser gælder?

Pr. organisation: 200 læsninger og 60 skrivninger pr. minut, og 20 pr. minut for tunge operationer, som at oprette produkter, uploade filer og starte kørsler. Derudover svarer API’et 429 med den ventetid, der skal overholdes.

Kan jeg ændre eller slette et produkt via API’et?

Ikke endnu. Du opretter produkter, og hvis du sender et eksisterende produkt igen, får det en ny version, når en værdi ændres. Ændringer og sletninger foretages i Upsellr.

Hvordan undgår jeg dubletter?

Upsellr genkender hvert produkt på dets EAN, dets SKU, eller dets producentens varenummer og mærke: at sende det samme produkt igen skaber ikke en dublet.

Kan jeg starte berigelsen fra mit værktøj?

Ja. Start berigelse, generering, begge dele, eller et af dine workflows, på et udvalg, en søgning eller hele kataloget, op til 50.000 produkter pr. kørsel.

Hvordan ved jeg, at en kørsel er færdig?

Forespørg kørslen via API’et, eller modtag en webhook, når den fuldføres, mislykkes eller stoppes.

Findes der et SDK?

Ikke i øjeblikket: API’et er et klassisk REST API, og referencen giver eksempler, der er klar til at kopiere.

Dit næste produkt
fortjener mere end kopiér og indsæt.

Giv dit AI-team de første produkter at arbejde med.