REST API

REST API: váš katalog v Upsellr, řízený z vlastních nástrojů.

Vytvářejte produkty ze svého ERP, nahrávejte soubory od dodavatelů, spouštějte obohacování a generování a poté čtěte obsah napsaný pro každý kanál a každý jazyk. Zdokumentované REST API s klíči s omezenými oprávněními.

Kategorie
API
Směr
Čtení a zápis
Verze
REST v2, specifikace OpenAPI
Klíče
Až 10 na organizaci, oprávnění dle výběru
Jazyky
Popisky ve francouzštině, angličtině, španělštině a němčině
Ověření
Klíč API v hlavičce Authorization
Tarify
Tarif Enterprise
Vydavatel
Upsellr

01Co API umí

Upsellr z vašich vlastních nástrojů.

  1. 01

    Vytvářejte produkty v dávkách

    Odešlete až 100 produktů v jednom volání. Upsellr je rozpozná podle EAN, SKU nebo kódu výrobce a značky: již známý produkt se neduplikuje, ale dostane novou verzi, pokud se změní některá hodnota.

  2. 02

    Čtěte svá master data

    Pole, seznamy hodnot, kategorie a šablony: vše, co strukturuje váš katalog, lze číst přes API, s popisky ve vašem jazyce.

  3. 03

    Nahrávejte soubory od dodavatelů

    Vložte tabulky a PDF do knihovny souborů Upsellr: až 10 MiB v jednom nahrání, větší soubory po částech.

  4. 04

    Spouštějte obohacování a generování

    Spusťte zpracování pro výběr, vyhledávání nebo celý katalog, až 50 000 produktů: Lily obohacuje master data, Max píše stránky pro vaše kanály, nebo se spustí jeden z vašich workflow.

  5. 05

    Čtěte vygenerovaný obsah

    Každý produkt vrací svá master data, importované hodnoty a vygenerovaný obsah, seřazené podle kanálu a jazyka.

  6. 06

    Sledujte zpracování

    Zpracování lze sledovat přes API nebo webhookem: dokončeno, neúspěšné nebo zastavené, váš nástroj dostane oznámení.

02Začínáme

Váš první požadavek za pár minut.

  1. 01

    Otevřete nastavení organizace

    Sekce API a webhooky, vyhrazená vlastníkům a administrátorům.

  2. 02

    Vytvořte klíč

    Zvolte jeho oprávnění: jen čtení, čtení a zápis, nebo plný přístup. Pokud chcete, přidejte datum vypršení a povolené IP adresy.

  3. 03

    Připojte ho ke svému nástroji

    Posílá se v hlavičce Authorization každého volání.

  4. 04

    Volejte API ze svého serveru

    Nevolá se z prohlížeče: vaše klíče zůstávají na straně serveru.

  5. 05

    Sledujte zpracování

    Přes API, nebo pomocí webhooku, který vás upozorní na konci každého zpracování.

03Zdroje

Co API umožňuje číst a zapisovat.

ZdrojČteníZápis
ProduktyAnoAno
EAN, SKU a kód výrobceAnoAno
Hodnoty master dataAnoAno
Vygenerovaný obsah, podle kanálu a jazykaAnoNe
Pole a seznamy master dataAnoNe
Zdrojové souboryAnoAnoAž 10 MiB, nebo po částech
Zpracování obohacování a generováníAnoAno
Cena

Kompatibilita a požadavky

  • Tarif Enterprise
  • Role vlastníka nebo administrátora pro vytváření klíčů
  • Server, který volá API, nikdy prohlížeč
  • Hlavička Authorization: Bearer u každého volání
  • Tip: jeden klíč na nástroj, jen s potřebnými oprávněními

Kontrolu máte vy

Klíče pod kontrolou.

  • Oprávnění pro každý klíč: jen čtení, čtení a zápis, nebo plný přístup
  • Datum vypršení a povolené IP adresy, pokud chcete
  • Limity volání na organizaci, s upozorněním při překročení
  • Identifikátor požadavku v každé odpovědi, pro podporu

04Otázky

Otázky k API Upsellr.

Je API součástí mého tarifu?

Je vyhrazeno pro tarif Enterprise. V ostatních tarifech je sekce API a webhooky viditelná, ale uzamčená.

Kde najdu dokumentaci?

Reference API se generuje z jeho specifikace OpenAPI, s příklady v curl, JavaScript, Python a Ruby.

Jaké jsou limity volání?

Na organizaci: 200 čtení a 60 zápisů za minutu a 20 za minutu pro náročné operace, jako je vytváření produktů, nahrávání souborů a spouštění zpracování. Při překročení API odpoví kódem 429 s dobou, kterou je třeba počkat.

Mohu přes API upravit nebo smazat produkt?

Zatím ne. Produkty vytváříte, a když existující produkt odešlete znovu, dostane novou verzi, pokud se změní některá hodnota. Úpravy a mazání se provádějí v Upsellr.

Jak se vyhnout duplicitám?

Upsellr rozpozná každý produkt podle jeho EAN, SKU, nebo kódu výrobce a značky: opětovné odeslání stejného produktu nevytvoří duplicitu.

Mohu spustit obohacování ze svého nástroje?

Ano. Spusťte obohacování, generování, obojí, nebo jeden ze svých workflow, pro výběr, vyhledávání nebo celý katalog, až 50 000 produktů na jedno zpracování.

Jak poznám, že zpracování skončilo?

Zjistěte stav zpracování přes API, nebo přijměte webhook, když se dokončí, selže nebo je zastaveno.

Existuje SDK?

Zatím ne: API je klasické REST API a reference nabízí příklady připravené ke zkopírování.

Váš další produkt
si zaslouží víc než Ctrl+C, Ctrl+V.

Dejte svému AI týmu první produkty k práci.