REST API

REST API: Upsellr-tuoteluettelosi, ohjattuna omista työkaluistasi.

Luo tuotteita ERP-järjestelmästäsi, lataa toimittajiesi tiedostot, käynnistä rikastus ja sisällön luonti ja lue sitten jokaiselle kanavalle ja kielelle kirjoitettu sisältö. Dokumentoitu REST API, jonka avaimilla on rajatut oikeudet.

Kategoria
API
Suunta
Luku ja kirjoitus
Versio
REST v2, OpenAPI-määrittely
Avaimet
Enintään 10 organisaatiota kohden, oikeudet valittavissa
Kielet
Nimikkeet ranskaksi, englanniksi, espanjaksi ja saksaksi
Todennus
API-avain Authorization-otsakkeessa
Paketit
Enterprise-paketti
Julkaisija
Upsellr

01Mitä API tekee

Upsellr omista työkaluistasi.

  1. 01

    Luo tuotteita erissä

    Lähetä enintään 100 tuotetta kutsua kohden. Upsellr tunnistaa ne EAN-koodista, SKU:sta tai valmistajan tuotenumerosta ja merkistä: jo tunnettua tuotetta ei monisteta, vaan se saa uuden version, kun jokin arvo muuttuu.

  2. 02

    Lue master data -tietojasi

    Kentät, arvolistat, kategoriat ja mallit: kaiken, mikä jäsentää tuoteluetteloasi, voi lukea API:n kautta, nimikkeet omalla kielelläsi.

  3. 03

    Lataa toimittajiesi tiedostot

    Vie laskentataulukkosi ja PDF-tiedostosi Upsellrin tiedostokirjastoon: enintään 10 MiB yhdellä latauksella, isommat useassa osassa.

  4. 04

    Käynnistä rikastus ja sisällön luonti

    Käynnistä ajo valinnalle, haulle tai koko tuoteluettelolle, enintään 50 000 tuotetta: Lily rikastaa master data -tietoja, Max kirjoittaa kanaviesi sivut, tai jokin työnkuluistasi suoritetaan.

  5. 05

    Lue luotu sisältö

    Jokainen tuote palauttaa master data -tietonsa, tuodut arvonsa ja luodun sisältönsä kanavan ja kielen mukaan järjestettynä.

  6. 06

    Seuraa ajojasi

    Ajoa voi seurata API:n kautta tai webhookilla: valmis, epäonnistunut tai pysäytetty, työkalusi saa ilmoituksen.

02Aloitus

Ensimmäinen pyyntösi muutamassa minuutissa.

  1. 01

    Avaa organisaation asetukset

    Osio API ja webhookit, vain omistajille ja ylläpitäjille.

  2. 02

    Luo avain

    Valitse sen oikeudet: vain luku, luku ja kirjoitus tai täydet käyttöoikeudet. Lisää halutessasi vanhenemispäivä ja sallitut IP-osoitteet.

  3. 03

    Liitä se työkaluusi

    Avain lähetetään jokaisen kutsun Authorization-otsakkeessa.

  4. 04

    Kutsu API:a palvelimeltasi

    Sitä ei kutsuta selaimesta: avaimesi pysyvät palvelimella.

  5. 05

    Seuraa ajojasi

    API:n kautta tai webhookilla, joka ilmoittaa sinulle jokaisen ajon päättymisestä.

03Resurssit

Mitä API:lla voi lukea ja kirjoittaa.

ResurssiLukuKirjoitus
TuotteetKylläKyllä
EAN, SKU ja valmistajan tuotenumeroKylläKyllä
Master data -arvotKylläKyllä
Luotu sisältö kanavittain ja kielittäinKylläEi
Master data -kentät ja -listatKylläEi
LähdetiedostotKylläKylläEnintään 10 MiB tai useassa osassa
Rikastus- ja sisällönluontiajotKylläKyllä
Hinta

Yhteensopivuus ja vaatimukset

  • Enterprise-paketti
  • Omistajan tai ylläpitäjän rooli avainten luomiseen
  • Palvelin, joka kutsuu API:a, ei koskaan selain
  • Authorization: Bearer -otsake jokaisessa kutsussa
  • Vinkki: yksi avain työkalua kohden, vain tarvittavilla oikeuksilla

Sinä päätät

Avaimet hallinnassa.

  • Oikeudet avainkohtaisesti: vain luku, luku ja kirjoitus tai täydet käyttöoikeudet
  • Vanhenemispäivä ja sallitut IP-osoitteet, jos haluat
  • Kutsurajat organisaatiota kohden, ylityksestä ilmoitetaan
  • Pyyntötunniste jokaisessa vastauksessa tukea varten

04Kysymykset

Kysymyksiä Upsellrin API:sta.

Sisältyykö API pakettiini?

Se on varattu Enterprise-paketille. Muissa paketeissa API ja webhookit -osio näkyy, mutta on lukittu.

Mistä löydän dokumentaation?

API-viite luodaan sen OpenAPI-määrittelystä, ja siinä on esimerkit kielillä curl, JavaScript, Python ja Ruby.

Mitkä ovat kutsurajat?

Organisaatiota kohden: 200 lukua ja 60 kirjoitusta minuutissa sekä 20 minuutissa raskaille toiminnoille, kuten tuotteiden luonnille, tiedostojen lataukselle ja ajojen käynnistykselle. Rajan ylittyessä API vastaa koodilla 429 ja kertoo odotusajan.

Voinko muokata tai poistaa tuotteen API:n kautta?

Et vielä. Voit luoda tuotteita, ja olemassa olevan tuotteen uudelleenlähetys antaa sille uuden version, kun jokin arvo muuttuu. Muokkaus ja poisto tehdään Upsellrissa.

Miten vältän kaksoiskappaleet?

Upsellr tunnistaa jokaisen tuotteen sen EAN-koodista, SKU:sta tai valmistajan tuotenumerosta ja merkistä: saman tuotteen uudelleenlähetys ei luo kaksoiskappaletta.

Voinko käynnistää rikastuksen työkalustani?

Kyllä. Käynnistä rikastus, sisällön luonti, molemmat tai jokin työnkuluistasi valinnalle, haulle tai koko tuoteluettelolle, enintään 50 000 tuotetta ajoa kohden.

Mistä tiedän, että ajo on päättynyt?

Kysy ajon tila API:n kautta tai vastaanota webhook, kun ajo valmistuu, epäonnistuu tai pysäytetään.

Onko SDK:ta saatavilla?

Ei toistaiseksi: API on tavallinen REST API, ja viitteessä on valmiita kopioitavia esimerkkejä.

Seuraava tuotteesi
ansaitsee muutakin kuin kopioi-liitä.

Anna tekoälytiimillesi ensimmäiset tuotteet työstettäviksi.