Vai al contenuto principale
CONFIGURA API

Configura API

Dylan Santaroni avatar
Scritto da Dylan Santaroni
Aggiornato oltre 3 settimane fa

Premessa

Su Poleepo è possibile generare chiavi API per usare le API Poleepo e automatizzare molti processi (dalla pubblicazione prodotti al recupero degli ordini) oppure si possono generare chiavi API per fare integrazioni personalizzate.

Puoi consultare la documentazione API di Poleepo a questo link:

Configura API

Per iniziare a configurare le chiavi API, segui il percorso Configurazioni > API

In questa sezione potrai creare chiavi API e Webhooks, gestire le credenziali di accesso e i Webhooks configurati
Ricordati che questi sono dati sensibili, condividi questi dati solo ad persone di cui ti fidi.

1. Creazione chiavi API

Per creare le tue chiavi API, clicca nella tendina in alto "Chiavi API" e poi su "crea chiave" in basso a destra.

Da qui puoi creare una nuova credenziale di accesso per applicazioni esterne a Poleepo. Ricorda che queste applicazioni possono accedere ai tuoi dati, consegna queste credenziali solo ad applicativi di cui ti fidi.

  • Per prima cosa dai il nome alla Chiave API che intendi creare;

  • Inserisci l'email di un referente tecnico che il nostro supporto può contattare in caso di problemi o nuove funzionalità per le API;

  • Scegli i permessi che vuoi dare alla Chiave;

    Fornitore

    Ad esempio scegliendo il fornitore Indicherai a quali informazioni la chiave avrà accesso (se selezionato il fornitore non potrà visionare dati di altri fornitori)

    Ordini

    Scegli il tipo di accesso che vuoi dare alla chiave (nessun accesso, in scrittura o il lettura) alla lista degli ordini, stato dell’ordine e assegnazione delle giacenze.

    Indica poi i dati da non visualizzare in uscita (Informazioni sensibili clienti o prezzi dell'ordine)

    Prodotti

    Scegli il tipo di accesso che vuoi dare alla chiave (nessun accesso, in scrittura o il lettura) alla lista degli prodotti, creazione nuovi prodotti, aggiornamento dati prodotto. Creazione e modifica dei dati delle pubblicazioni.

    Spedizioni

    Scegli il tipo di accesso che vuoi dare alla chiave (nessun accesso, in scrittura o il lettura) alla lista delle spedizioni, creazione nuove spedizioni, aggiornamento dati spedizioni. Creazione e modifica e download delle lettere di vettura dei correri.

Clicca infine su "Salva" per salvare la chiave appena creata.

Una volta salvato, il sistema genererà una coppia di chiavi (una pubblica e una privata) che dovrai copiare e tenere al sicuro, soprattutto quella privata che non sarà più visualizzabile una volta chiuso l'alert.

Abilita la chiave appena creata

Abilita la chiave appena creata per renderla funzionante, spuntando il pulsante in alto a destra "attiva".

Puoi visualizzare, attivare, cancellare o modificare le chiavi create tornando nella schermata principale, in cui ci sarà una lista con le informazioni di tutte le chiavi che hai generato.

2. Creazione Webhooks

Per creare invece un Webhook, seleziona la voce nella tendina in alto e poi clicca su "crea Webhook"

Per creare un nuovo Webhook (ricordati che queste applicazioni possono accedere ai tuoi dati, consegna questi dati solo ad applicativi di cui ti fidi)

  • dai un nome alla configurazione;

  • inserisci la mail di un referente tecnico che il nostro supporto potrà contattare in caso di problemi o nuove funzionalità per i Webhooks;

  • inserisci l'Url configurata;

  • seleziona un valore nella lista dei permessi da dare;

  • Clicca infine su "salva" per salvare il Webhook appena creato.

Una volta salvato, il sistema genererà una chiave segreta da copiare e tenere al sicuro. Ricordati che sarà possibile visualizzare di nuovo la chiave privata nel dettaglio del Webhook.

Abilita il Webhook appena creato

Abilita il Webhook appena creato, spuntando il pulsante in alto a destra "attiva".

Puoi visualizzare, attivare, cancellare o modificare i Webhooks creati tornando nella schermata principale, in cui ci sarà una lista con le informazioni di tutti i Webhooks che hai generato.

Hai ricevuto la risposta alla tua domanda?