Documentazione
API versione 1.0
A cosa servono?
Letteralmente "API" è l'acronimo di Application programming interface e sono una serie di istruzioni che permetto ad un software di comunicare con altri.
La prima versione di queste API vi permette di inserire all'interno dei vostri siti una "Coccarda" con riferimento alla pagina dedicata su ItalianWebGallery.it .
Ci sono attualmente 2 metodi per aggiungere la "Coccarda" alle vostre pagine:
- codice JavaScript
- codice X/HTML
Metodo 1) Codice JavaScript
Richiamando un file JavaScript all'interno delle vostre pagine otterrete automaticamente il link alla pagina dedicata al vostro sito su ItalianWebGallery.it .
Il codice da inserire tra i tag <head>...</head> è il seguente:
<script type="text/javascript"
src="http://api.italianwebgallery.it/v1/medal.js?sn=NOME_SITO">
</script>
NOME_SITO indica il nome / identificativo che il sistema assegna ad ogni sito della directory e lo si può trovare facilemnte all'interno degli URL di ItalianWebGallery.it . Ecco come:
http://www.italianwebgallery.it/sites/italianwebgallery.html
Reperire il NOME_SITO è molto facile, si tratta semplicemente del "base-name" della pagina dedicata su ItalianWebGallery.it .
Parametri da passare a "medal.js"
| Parametri | Richiesto | Descrizione | Default |
|---|---|---|---|
| sn | Sì | Nome / identificativo univoco del sito all'interno della directory | - |
| z | No | z-index | 100000 |
| v | No | Versione API | 1 |
Dati relativi a "medal.js"
| Nome file | MIME | Dimensioni | Compressione |
|---|---|---|---|
| medal.js | text/javascript | Circa 1200 byte Circa 500 byte compresso |
gzip |
Una volta incorporato, il codice è pienamente funzionante.
Metodo 2) Codice X/HTML
Il codice JS visto nell'esempio precedente è stato realizzato in modo da avere il minor impatto possibile sulle vostre pagine.
Nel caso ci fossero conflitti con il codice JS delle vostre pagine o, più semplicemente, voleste inserire il codice HTML direttamente, lo snippet da incorporare immediatamente prima della chiusura del <body> è questo :
<div style="display: block; position: absolute; width: 100px; height: 100px; top: 0pt; right: 0pt; z-index: 100000;"><a style="display: block; position: relative; width: 100px; height: 100px; background-image: url("http://api.italianwebgallery.it/img/coccarda_iwg.png"); background-position: center center; background-repeat: no-repeat;" href="http://www.italianwebgallery.it/sites/NOME_SITO.html" target="_blank"></a></div>
NOME_SITO indica il nome / identificativo che il sistema assegna ad ogni sito della directory e lo si può trovare facilemnte all'interno degli URL di ItalianWebGallery.it . Ecco come:
http://www.italianwebgallery.it/sites/italianwebgallery.html
Reperire il NOME_SITO è molto facile, si tratta semplicemente del "base-name" della pagina dedicata su ItalianWebGallery.it .
