Usare l'API pubblica

L’API pubblica di Upsellr dà accesso alla vostra master data, ai vostri prodotti, alle vostre fonti e ai vostri workflow dai vostri strumenti. È inclusa nell’offerta Enterprise.

L’essenziale

• Indirizzo di base: https://api.upsellr.io/v2
• Autenticazione: ogni richiesta porta l’intestazione Authorization con il valore Bearer seguito dalla vostra chiave. Vedere creare e gestire chiavi API.
• Documentazione: il riferimento completo, con esempi, è pubblicato su docs.upsellr.io.

Chiamate solo da un server

L’API si chiama da un server, mai da un browser: non risponde alle richieste inviate da una pagina web. Questo evita anche di esporre la vostra chiave nel codice di una pagina.

I limiti di frequenza

I limiti si applicano all’intera organizzazione, tutte le chiavi insieme.

Tipo di richiesta	Al minuto	Burst
Letture	200	30
Scritture	60	10
Scritture pesanti: creazione di prodotti, caricamento di file, avvio di workflow	20	5
Ricerca e lettura di prodotti	60	5

Oltre, l’API risponde con il codice 429 e un’intestazione Retry-After che indica, in secondi, quando riprovare.

Identificativo di richiesta

Ogni risposta porta un’intestazione X-Request-Id. Se una richiesta non riesce in modo inatteso, annotate questo identificativo e trasmettetelo al supporto: permette di ritrovare esattamente la vostra chiamata.

Buono a sapersi

• Una chiave limitata a determinati indirizzi IP o determinati User-Agent viene rifiutata da qualsiasi altra origine.
• Troppe richieste con una chiave non valida da uno stesso indirizzo comportano un blocco temporaneo, segnalato da un codice 429.
• Una chiave agisce solo nei limiti dei suoi ambiti: una richiesta fuori ambito viene rifiutata.
• Avviare un workflow tramite l’API consuma crediti come dall’applicazione.
• Per essere avvisati della fine di un’esecuzione senza interrogare l’API in continuazione, usate i webhook.
• Una domanda? Passate dalla pagina contatti o dal pulsante Report a bug nell’app, con l’identificativo di richiesta.