Documentazione servizi web - pm7
←
→
Trascrizione del contenuto della pagina
Se il tuo browser non visualizza correttamente la pagina, ti preghiamo di leggere il contenuto della pagina quaggiù
Documentazione servizi web
versione 2.0
gennaio 2018documentazione utilizzo API
indice
Cosa sono 3
Chi può richiederle e come 3
Tipologie di chiamate 3
API 1.0
Effettuare una richiesta 4
Contenuto delle risposte 5
Implementazione delle immagini con
sistema manuale 6
Implementazione delle immagini con
tecnologia JSON 7
API 2.0
Effettuare una richiesta 8
Richiedere un file .csv 8
contenuto delle risposte 9
-2-documentazione utilizzo API
COSA SONO
Con application programming interface (in acronimo API, in italiano
interfaccia di programmazione di un’applicazione), in informatica, si
indica ogni insieme di procedure disponibili al programmatore, di solito
raggruppate a formare un set di strumenti specifici per l’espletamento di
un determinato compito all’interno di un certo programma. Spesso con tale
termine si intendono le librerie software disponibili in un certo linguaggio di
programmazione.
Da Wikipedia, l’enciclopedia libera.
CHI PUÒ RICHIEDERLE E COME
Le API che ActionWear mette a disposizione sono ad esclusivo utilizzo dei
propri clienti e sono attivabili inviando una richiesta tramite l’apposito form
che si trova nella propria area riservata sul sito action-wear.com.
Ogni richiesta di utilizzo delle API sarà soggetta a valutazione.
I dati necessari per accedere al servizio sono il codice cliente e l’indirizzo IP
dal quale verrà inoltrata la richiesta. Questo indirizzo IP deve essere statico
in quanto i dati potranno essere visualizzati solo ed esclusivamente tramite
l’indirizzo (o gli indirizzi) IP forniti.
Dal 2018 è disponibile una nuova serie di API. All’interno è presente tutto il
database ActionWear con moltissime informazioni (descrizioni in 4 lingue,
dimensioni prodotto, categorie, url delle immagini e molto altro).
Data la mole di informazione queste informazioni possono essere utilizzate
solo tramite tecnologia JSON.
TIPOLOGIE DI CHIAMATE
Da oggi quindi sono disponibili 2 tipologie di API che chiameremo: API 1.0 e
API 2.0. Le API 1.0 continueranno ad essere disponibili parrallelamente alle
2.0.
Per le prime esistono due tipologie di chiamata:
1. richiamare un file CSV tramite un URL,
2. richiamare le informazione tramite chiamata a terminale in JSON
Per le seconde, visto la mole di informazioni, sarà possibile richiamare le
informazioni solamente tramite tecnologia JSON.
-3-documentazione utilizzo API
API 1.0
EFFETTUARE UNA RICHIESTA
Non appena approvata la vostra domanda vi forniremo un auth key con il
quale sarà possibile accedere al nostro database.
Per poter accedere al file .csv sarà necessario utilizzare questo URL:
action-wear.com/listino/listino.php?code=12345&key=eb-
d2f1228332cqcfea42ab0b35c5ads134w52a5c
in grigio la parte statica, in verde il codice cliente, in rosso l’auth key.
se si vuole utilizzare la tecnologia JSON la richiesta deve essere fatta in
questo modo:
curl --header 'Authorization: ebd2f5228632cacfeac2ab0b35c5ad-
d134a52a5c' http://action-wear.com:8080/api/12345/
curl --header 'authorization: 0581acf452eafebf1b386eb-
77d091402553289bb' http://action-wear.com:8080/apifull/85021/
TJ145
In questo modo viene richiesto tutto il database.
Nel caso si voglia richiedere solo un prodotto sarà sufficiente aggiungere lo
SKU in fondo
curl --header 'Authorization: ebd2f5228632cacfeac2ab0b35c5ad-
d134a52a5c' http://action-wear.com:8080/api/12345/TJ145
-4-documentazione utilizzo API
CONTENUTO DELLE RISPOSTE
Il contenuto della risposta del server è strutturata in questo modo:
{
“descrizione_colore”: “White”,
“colore”: “001”,
“prezzi”: [14.34, 13.54, 12.09, 11.75],
“arrivi”: [[“S”, 25], [“M”, 25]],
“marca”: “TEE JAYS”,
“disponibilita”: [[“S”, 26], [“M”, 28], [“L”, 38], [“XL”, 19],
[“XXL”, 4], [“3XL”, 0]],
“misure”: [[“S”, “42,00”, “62,00”], [“M”, “44,00”, “64,00”],
[“L”, “48,00”, “66,00”], [“XL”, “50,00”, “68,00”], [“XXL”,
“52,00”, “70,00”], [“3XL”, “54,00”, “72,00”]],
“codice”: “TJ145”,
“famiglia”: “DONNA”,
“nome”: “Ladies Luxury Stretch Polo”,
“quantita”: [1, 1, 25, 250],
“descrizione”: “Lady Lux Stretch Polo 95%C5%E”,
“descrizione_estesa”: “95% cotone pettinato ringspun, 5%
elastane. Polo manica corta, tessuto mini piquet, collo e
maniche con costina in maglia con lycra, 5 bottoni tono su
tono, nastro di rinforzo al collo, vestibilità femminile.”
},
Descrizione_colore: nome colore per esteso
Colore: codice colore
Prezzi: i prezzi sono divisi in base alla quantità acquistata. in questo caso il
terzo numero (12.09) è riferito all’acquisto che va da 25 pezzi fino a 249.
Arrivi: sono i pezzi in arrivo nel nostro magazzino da quello dei nostri
fornitori.
Marca: brand del prodotto.
Disponibilità: i dati si riferiscono allo stock disponibile nel nostro magazzino
divisi per taglie.
Misure: [“taglia”, “larghezza”, “altezza”].
Codice: SKU dell’articolo.
Famiglia: categoria di appartenenza.
Nome: nome dell’articolo.
Quantità: il primo dato è riferito al pezzo singolo, il secondo all’imballo, il
terzo al cartone, il quarto a 10 cartoni.
Descrizione: descrizione breve del prodotto dove è indicato il nome e la
composizione (serve ad esempio nel documento di trasporto).
Descrizione estesa: descrizione estesa del prodotto.
-5-documentazione utilizzo API
IMPLEMENTAZIONE DELLE IMMAGINI CON SISTEMA MANUALE
Ci sono due possibilità al momento per l’implementazione delle immagini,
la prima consiste nello scaricare un file .zip dove sono presenti tutte le
immagini organizzate in cartelle e nominate secondo regole prestabilite.
I link per scaricare le immagini sono:
http://action-wear.com/immagini.zip (dove trovare le immgini dei colori)
http://action-wear.com/immagini-base.zip (dove trovare le immgini principali)
(i file sono molto pesanti, consigliamo di utilizzare un download manager)
di seguito la descrizione delle regole con le quali sono nominate le
immagini
1 immagini base dei colori:
ATLANTIS/COLOR_AR/AR#orange.jpg
2 immagini principali dei prodotti:
ATLANTIS/PRODUCT_ATACTI/ATACTI#01.jpg
ATLANTIS/PRODUCT_ATACTI/ATACTI#02.jpg
...
3 immagini colori dei prodotti:
ATLANTIS/PRODUCT_ATACTI/COLOR_AR/AR#ATACTI_01.jpg
ATLANTIS = marca
AR = codice colore
ATACTI = codice articolo
-6-documentazione utilizzo API
IMPLEMENTAZIONE DELLE IMMAGINI CON TECNOLOGIA JSON
Il secondo sistema per ottenere le immagini è tramite chiamata JSON.
qui sotto per esempio facciamo la richiesta delle immagini per l’articolo
TJ145
curl --header “Authorization: ebd2f5228632cacfeac2ab0b35c5ad-
d134a52a5c” http://action-wear.com:8081/images/TJ145
Il contenuto della risposta del server è strutturata in questo modo:
{
“base”: [“http://action-wear.com/camac/image_manager/data/TEE
JAYS/PRODUCT_TJ145/TJ145#01.jpg”],
[“http://action-wear.com/camac/image_manager/data/TEE JAYS/
PRODUCT_TJ145/TJ145#02.jpg”],
“001”: [“http://action-wear.com/camac/image_manager/data/TEE
JAYS/PRODUCT_TJ145/COLOR_001/001#TJ145_01.jpg”],
“002”: [“http://action-wear.com/camac/image_manager/data/TEE
JAYS/PRODUCT_TJ145/COLOR_002/002#TJ145_01.jpg”],
},
Base: è l’immagine o le immagini principali del prodotto
001 - 002 ecc..: sono le immagini collegate ai codici colore
-7-documentazione utilizzo API
API 2.0
EFFETTUARE UNA RICHIESTA
Le richieste dovranno essere effettuate tramite tecnologia JSON.
Qui di seguito la sintassi per la chiamata dell’intero database.
Ricordiamo che il database ha una dimensione di circa 100MB percui è
consigliato effettuare richieste di prodotti specifici.
curl --header 'Authorization: ebd2f5228632cacfeac2ab0b35c5ad-
d134a52a5c' http://action-wear.com:8080/apifull/12345/
Come per le API 1.0 in grigio la parte statica, in verde il codice cliente, in
rosso l’auth key.
Con questo comando viene viene richiesto tutto il database.
Nel caso si voglia richiedere solo un prodotto sarà sufficiente aggiungere lo
SKU in fondo come da esempio qui sotto:
curl --header 'Authorization: ebd2f5228632cacfeac2ab0b35c5ad-
d134a52a5c' http://action-wear.com:8080/apifull/12345/TJ145/
RICHIEDERE UN FILE .CSV
Anche se fortemente sconsigliato, è possibile richiamare un file .csv per il
popolamento iniziale dell’ecommerce.
Ricordiamo che il file sarà di circa 100MB percui di difficile gestione.
Per richiamare questo file si dovrà utilizzare la sintassi qui sotto (senza spazi)
action-wear.com/listino/listinofull.php?co-
de=85021&key=0581acf452eafebf1b386eb77d091402553289bb
-8-documentazione utilizzo API
CONTENUTO DELLE RISPOSTE
Il contenuto della risposta del server è strutturata in questo modo:
[
{
“upc-ean-gtin”: “”,
“nom.comb”: “”,
“marchio”: “TEE JAYS”,
“sku camac”: “TJ145”,
“sku fornitore”: “”},
“taglia”: “S”,
“codice colore”: “011”,
“nome colore”: “Indigo”,
“famiglia”: “Polo”,
“maniche”: “Manica corta”,
“tessuto”: “Cotone”,
“peso m2”: “215”,
“genere”: “Donna”,
“nome ita”: “Ladies luxury stretch polo”,
“descrizione ita”: “Polo luxury stretch donna, 215 g/m2,
95% cotone ring-spun, 5% elastan, tessuto mini pique, pre-
ristretto, fettuccia al collo, colletto a costine Lycra,
abbottonatura con rifinitura accurata, taglio modellato.
Cuciture laterali”,
“nome eng”: “Ladies luxury stretch polo”,
“descrizione eng”: “95% ringspun combed cotton/5% elastane.
Mini pique, Flat knit collar with lycra, Mini pique, Double
preshrunk, Neck tape, Clean finished placket”,
“nome esp”: “Polo ajustado Luxury mujer”,
“descrizione esp”: “95% algod\u00f3n ring-spun, 5% elast\
u00e1n, Mini piqu\u00e9, Pre-encogido, Cuello encintado,
Cuello de lycra de punto plano, Tapeta con acabado limpio,
Corte ajustado, 215 g/m\u00b2”,
“nome fra”: “luxury stretch polo femme”,
“descrizione fra”: “215 g/m², 95% coton ringspun, 5%
élasthanne, mini piquéprérétréci 2x, bande de propreté, col
plat en lycra, patte de boutonnage, cintré”,
“nome de”: “”,
“descrizione de”: “”,
“descrizione breve”: “Lady Lux Stretch Polo 95%C5%E”,
“vestibilita”: “slim fit”,
“collezioni”: “fashion”,
“categorie”: “[‘CATALOGO|Polo|Polo sportive’, ‘MARCHI|TEE
JAYS|Polo|Polo sportive’]”,
“dettagli”: “bicolore”,
“peso prodotto”: 0.165,
-9-documentazione utilizzo API
“immagini base”: “[\”/TEE%20JAYS/PRODUCT_TJ145/TJ145#01.jpg\”,
\”/TEE%20JAYS/PRODUCT_TJ145/TJ145#02.jpg\”, \”/TEE%20JAYS/
PRODUCT_TJ145/TJ145#03.jpg\”, \”/TEE%20JAYS/PRODUCT_TJ145/
TJ145#04.jpg\”]”,
“immagini colore”: “[\”/TEE%20JAYS/PRODUCT_TJ145/
COLOR_011/011%23TJ145_01.jpg\”]”,
“imballo”: 1,
“cartone”: 25,
“prezzo unita”: 16.9,
“prezzo imballo”: 16.9,
“prezzo cartone”: 14.25,
“prezzo 10 cartoni”: 13.85,
“stock”: 48,
“stock fornitore”: 115,
“arrivi”: 0,
“misure larghezza”: “42,00”,
“misure altezza”: “62,00”,
“correlati”: “TJ1405”,
“pagina catalogo”: “0105”,
Questa è la prima riga della risposta completa e si riferisce all’articolo taglia
colore: articolo “JE145” in taglia “S” colore “011”.
Questo articolo è disponibile in 6 taglie e 24 colori, significa che il database
genera 144 righe.
Questo sistema ci rende capaci di fornire tutte le informazioni quali peso
prodotto, misure, immagini colore, che altrimenti non sarebbero disponibili.
per scaricare l’intera risposta collegarsi a questo url: http://pm7.it/tj145.zip
Qui di seguito descriverò le varie informazioni:
upc-ean-gtin: codice upc, ean o gitin secondo disponibilità.
nom.comb: codice TARIC.
marchio: brand del prodotto.
sku camac: codice del prodotto.
sku fornitore: codice del fornitore.
taglia: taglia.
codice colore: codice colore.
nome colore: nome colore per esteso.
famiglia: categoria di appartenenza.
maniche: tipologia di maniche.
tessuto: composizione del tessuto.
peso m2: peso del tessuto in m2.
genere: uomo, donna, unisex.
nome ita: nome dell’articolo in lingua italiana.
descrizione ita: descrizione dell’articolo in lingua italiana.
nome eng: nome dell’articolo in lingua inglese.
descrizione eng: descrizione dell’articolo in lingua inglese.
- 10 -documentazione utilizzo API
nome esp: nome dell’articolo in lingua spagnola.
descrizione esp: descrizione dell’articolo in lingua spagnola.
nome fra: nome dell’articolo in lingua francese.
descrizione fra: descrizione dell’articolo in lingua francese.
nome de: nome dell’articolo in lingua tedesca.
descrizione de: descrizione dell’articolo in lingua tedesca.
descrizione breve: descrizione breve ai fini fiscali.
vestibilita: fit del prodotto.
collezioni: tag.
categorie: tag.
dettagli: tag.
peso prodotto: peso del prodotto.
immagini base: url delle immagini di base.
immagini colore: url delle immagini del colore.
imballo: quantità di articoli all’interno dell’imballo.
cartone: quantità di articoli all’interno dell’cartone.
prezzo unita: prezzo unitario.
prezzo imballo: prezzo per quantità imballo.
prezzo cartone: prezzo per quantità cartone.
prezzo 10 cartoni: prezzo per quantità 10 cartoni.
stock: quantità nel nostro magazzino.
stock fornitore: quantità nel magazzino del fornitore.
arrivi: sono i pezzi in arrivo nel nostro magazzino da quello dei nostri
fornitori.
misure larghezza: larghezza del prodotto in cm.
misure altezza: altezza del prodotto in cm.
correlati: articoli correlati.
pagina catalogo: pagina corrispondente sul catalogo cartaceo.
- 11 -ActionWear è un marchio di Camac Arti Grafiche srl
via Fossalta, 3377 - 47020 Pievesestina - Cesena (FC) Italy
T. +39 0547 31 67 11 - info@camacartigrafiche.com
action-wear.comPuoi anche leggere
