Questo articolo illustra i passaggi per caricare e scaricare prodotti utilizzando l'API Scantrust. Innanzitutto, è necessario un token UAT con le seguenti autorizzazioni:
- creazione_prodotto
- elimina prodotto
- edizione_prodotto
- vista del prodotto
Sarà inoltre necessario che nel Portale sia configurato almeno un marchio: ogni prodotto creato deve essere assegnato a un marchio.
Importante:
Per accedere all'API REST di Scantrust, puoi utilizzare una piattaforma API come Postman, la piattaforma API più diffusa al mondo, con oltre 17 milioni di utenti e 500.000 organizzazioni in tutto il mondo. Lo strumento offre un ambiente flessibile e collaborativo che ti consente di progettare, sviluppare, documentare e testare le tue API più velocemente.
Puoi provare l'app web o scaricare e installare questa app da questo link: https://www.postman.com/downloads/ In ogni caso è necessario registrarsi con un indirizzo email valido.
Nota: nel contesto di Scantrust, Postman dovrebbe essere utilizzato solo a scopo di test. Non dovrebbe essere utilizzato in scenari reali o implementazioni di progetto.
Passaggi per configurare Postman:
1. Apri Postman. Nella home page dovresti vedere quanto segue:
2. Quindi, fare clic sulla scheda "Aree di lavoro" nell'angolo in alto a sinistra:
3. Quindi, fare clic sull'opzione "Il mio spazio di lavoro":
4. Una volta entrati nell'area di lavoro, fare clic sul segno "+" come segue:
5. Successivamente, apparirà una nuova scheda con una richiesta API preconfigurata: GET:
6. Ora è importante configurare l'autorizzazione API. Per farlo, clicca sulla scheda "Autorizzazione":
7. Successivamente, fare clic sulla sezione "Tipo" e selezionare l'opzione "Chiave API", come segue:
8. Ora digita la parola "Autorizzazione" nel campo chiave, quindi copia il tuo token UAT dal portale ST e incollalo nel campo "Valore", inclusi i caratteri UAT. UAT [tu token], lasciando una barra spaziatrice tra la stringa UAT e il token:
9. Successivamente, vai alla scheda "Corpo", seleziona "raw" e seleziona "JSON":
Passaggi per caricare prodotti con l'API Scantrust
1. A questo punto, sei pronto a caricare un prodotto utilizzando l'API Scantrust. Per prima cosa, devi modificare la richiesta API in POST. Fai clic sul pulsante di richiesta e seleziona l'opzione "POST".
2. Per configurare questa richiesta, sarà necessario inserire l'URL, che in questo caso è il seguente: https://api.scantrust.com/api/v2/products/:
3. Quindi, nella scheda corpo, digitare quanto segue:
{
"sku": "PR3",
"marca": 2841,
"nome": "Prodotto tre",
"description": "Il terzo prodotto di una serie di molti altri."
"client_url": "http://www.examplebrand.com/productone",
"campagna": 575
}
Dove SKU si riferisce allo SKU univoco del prodotto all'interno dell'azienda, brand si riferisce all'ID del marchio (intero) o al riferimento (stringa) e name si riferisce al nome del prodotto. Tutti questi sono campi obbligatori per stabilire la richiesta.
D'altro canto, il campo "descrizione" si riferisce a una breve descrizione del prodotto; l'"URL client" si riferisce all'URL del prodotto, che può essere utilizzato per reindirizzare i codici se non è attiva una campagna per il prodotto; e il campo "immagine" consente di includere un'immagine del prodotto, in genere utilizzata nelle landing page di STC. Se non impostato, verranno utilizzate l'immagine del brand e l'immagine della campagna, ovvero l'ID di una campagna esistente all'interno dell'azienda a cui aggiungere il prodotto. Questi sono tutti campi facoltativi.
4. Una volta completato lo script del codice, possiamo fare clic sul pulsante INVIA:
5. Quando un prodotto viene pubblicato correttamente, la risposta appare così:
Se il caricamento è andato a buon fine, la risposta di stato dovrebbe essere 200 o 201. È quindi possibile verificare la creazione di questo nuovo prodotto nel portale Scantrust.
Passaggi per scaricare i prodotti con l'API Scantrust
Avrai bisogno di un token UAT con le seguenti autorizzazioni:
- product_view
In questo caso recupereremo le informazioni sul prodotto per un'intera azienda o per un prodotto specifico utilizzando solo lo SKU del prodotto.
1. Vai all'area di lavoro di Postman e apri una nuova scheda con il segno "+":
2. Quindi, vai alla scheda "Corpo" e seleziona "nessuno":
3. Per scaricare le informazioni sul prodotto, è necessario impostare una richiesta GET immettendo l'URL, che in questo caso è il seguente: https://api.scantrust.com/api/v2/products/:
4. Quindi fare clic sul pulsante INVIA:
5. Se la richiesta API ha avuto esito positivo, la risposta di stato dovrebbe essere 200 e verrà fornita la seguente risposta:
Questa risposta include tutti i prodotti elencati nella tua azienda, con attributi specifici quali SKU, nome, descrizione, marchio e altro ancora.
6. Se si desidera conoscere informazioni specifiche sul prodotto, dobbiamo configurare la richiesta GET inserendo l'URL, che in questo caso è il seguente: https://api.scantrust.com/api/v2/products/?sku_exact=[Codice articolo]:
In questo caso, la risposta include solo le informazioni sul prodotto per l'ID specificato nell'URL.
Commenti