API REST
API REST: il vostro catalogo Upsellr, gestito dai vostri strumenti.
Create prodotti dal vostro ERP, inviate i file dei fornitori, avviate l’arricchimento e la generazione, poi leggete i contenuti redatti per ogni canale e ogni lingua. Un’API REST documentata, con chiavi dai permessi limitati.
- Categoria
- API
- Direzione
- Lettura e scrittura
- Versione
- REST v2, specifica OpenAPI
- Chiavi
- Fino a 10 per organizzazione, permessi a scelta
- Lingue
- Etichette in francese, inglese, spagnolo e tedesco
- Autenticazione
- Chiave API nell’intestazione Authorization
- Piani
- Piano Enterprise
- Editore
- Upsellr
01Cosa fa l’API
Upsellr, dai vostri strumenti.
- 01
Create i prodotti in blocco
Inviate fino a 100 prodotti per chiamata. Upsellr li riconosce da EAN, SKU o codice produttore e marca: un prodotto già noto non viene duplicato, ma riceve una nuova versione se un valore cambia.
- 02
Leggete il vostro master data
Campi, elenchi di valori, categorie e modelli: ciò che struttura il vostro catalogo si legge tramite l’API, con le etichette nella vostra lingua.
- 03
Inviate i file dei fornitori
Caricate fogli di calcolo e PDF nella libreria dei file di Upsellr: fino a 10 MiB in un unico invio, oltre in più parti.
- 04
Avviate arricchimento e generazione
Avviate un’elaborazione su una selezione, una ricerca o tutto il catalogo, fino a 50.000 prodotti: Lily arricchisce il master data, Max scrive le schede dei vostri canali, oppure si esegue uno dei vostri workflow.
- 05
Leggete i contenuti generati
Ogni prodotto restituisce il suo master data, i valori importati e i contenuti generati, ordinati per canale e per lingua.
- 06
Seguite le vostre elaborazioni
Un’elaborazione si segue tramite l’API o via webhook: completata, non riuscita o interrotta, il vostro strumento viene avvisato.
02Per iniziare
La vostra prima richiesta in pochi minuti.
- 01
Aprite le impostazioni dell’organizzazione
Sezione API e webhook, riservata ai proprietari e agli amministratori.
- 02
Create una chiave
Scegliete i permessi: sola lettura, lettura e scrittura, o accesso completo. Aggiungete una data di scadenza e indirizzi IP autorizzati, se lo desiderate.
- 03
Collegatela al vostro strumento
Si invia nell’intestazione Authorization di ogni chiamata.
- 04
Chiamate l’API dal vostro server
Non si chiama da un browser: le vostre chiavi restano lato server.
- 05
Seguite le vostre elaborazioni
Tramite l’API, o con un webhook che vi avvisa al termine di ogni elaborazione.
03Risorse
Cosa l’API permette di leggere e scrivere.
| Risorsa | Lettura | Scrittura |
|---|---|---|
| Prodotti | Sì | Sì |
| EAN, SKU e codice produttore | Sì | Sì |
| Valori del master data | Sì | Sì |
| Contenuti generati, per canale e per lingua | Sì | No |
| Campi ed elenchi del master data | Sì | No |
| File sorgente | Sì | SìFino a 10 MiB, o in più parti |
| Elaborazioni di arricchimento e generazione | Sì | Sì |
| Prezzo |
Compatibilità e requisiti
- Il piano Enterprise
- Un ruolo di proprietario o amministratore per creare le chiavi
- Un server per chiamare l’API, mai un browser
- L’intestazione Authorization: Bearer in ogni chiamata
- Consiglio: una chiave per strumento, con i soli permessi necessari
Il controllo resta vostro
Chiavi sotto controllo.
- Permessi per chiave: sola lettura, lettura e scrittura, o accesso completo
- Una data di scadenza e indirizzi IP autorizzati, se lo desiderate
- Limiti di chiamate per organizzazione, segnalati in caso di superamento
- Un identificativo di richiesta in ogni risposta, per l’assistenza
04Domande
Domande sull’API di Upsellr.
L’API è inclusa nel mio piano?
È riservata al piano Enterprise. Negli altri piani, la sezione API e webhook è visibile ma bloccata.
Dove trovo la documentazione?
Il riferimento dell’API è generato dalla sua specifica OpenAPI, con esempi in curl, JavaScript, Python e Ruby.
Quali sono i limiti di chiamate?
Per organizzazione: 200 letture e 60 scritture al minuto, e 20 al minuto per le operazioni pesanti, come la creazione di prodotti, l’invio di file e l’avvio di elaborazioni. Oltre, l’API risponde 429 con il tempo di attesa.
Posso modificare o eliminare un prodotto tramite l’API?
Non ancora. Voi create i prodotti, e reinviare un prodotto esistente gli assegna una nuova versione se un valore cambia. La modifica e l’eliminazione si fanno in Upsellr.
Come evito i duplicati?
Upsellr riconosce ogni prodotto dal suo EAN, dal suo SKU, o dal codice produttore e dalla marca: reinviare lo stesso prodotto non lo duplica.
Posso avviare l’arricchimento dal mio strumento?
Sì. Avviate l’arricchimento, la generazione, entrambi, o uno dei vostri workflow, su una selezione, una ricerca o tutto il catalogo, fino a 50.000 prodotti per elaborazione.
Come so che un’elaborazione è terminata?
Interrogate l’elaborazione tramite l’API, oppure ricevete un webhook quando si completa, non riesce o viene interrotta.
Esiste un SDK?
Per ora no: l’API è una classica API REST, e il riferimento fornisce esempi pronti da copiare.
Il tuo prossimo prodotto
merita più di un copia e incolla.
Affida al tuo team IA i primi prodotti su cui lavorare.
Marcus
Amazon