La pagina Web in API icona converte gli URL into icone, prova questo dimostrazione vederlo in azione. L'API Webpage to Icon non è semplicemente un favicon grabber, ma basa invece l'icona finale su tutte le icone disponibili per la pagina web. Se non sono disponibili icone, ne verrà generata una per la pagina Web. L'icona della fonte scelta, lo sfondo e qualsiasi bordo selezionato possono cambiare a seconda delle esigenze degli utenti.
Per iniziare con l'API, sostituire l'esempio di testo CHIAVE APPLICAZIONE nella chiamata seguente con la chiave dell'applicazione quindi impostare il parametro size, che per impostazione predefinita è 32. Infine, specifica la pagina web che vuoi trasformare into un'icona, passando l'URL richiesto al parametro URL. Nel seguente esempio https://www.tesla.com viene convertito into Icona pixel 48x48.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com
È una buona idea mantenere url parametro come ultimo parametro nella querystring poiché ciò evita di dover codificare l'URL per la maggior parte degli URL passati alla pagina Web all'API Icon.
Mentre l'icona può essere scaricata con una lingua lato server come PHP. Può anche essere visualizzato direttamente in una pagina Web come mostrato di seguito. Ricordare che quando si utilizza l'API Icon in una pagina Web, è necessario aggiungere il dominio della pagina Web all'elenco di domini autorizzati.
<img src="//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com"/>
Un'icona può anche essere trasformata, basta passare la trasformazione che si desidera applicare dalle opzioni seguenti. Un esempio di ciò che può essere visto qui è che la trasformazione rende seppia icona risultante.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&transform=sepia&size=48&url=https://www.tesla.com
L'API Webpage to Icon accetta i seguenti quattro parametri.
| Nome | DESCRIZIONE | Opzioni |
|---|---|---|
| chiave | La tua chiave dell'applicazione | Questo parametro è obbligatorio per creare un'icona immagine |
| URL | L'URL della pagina Web da convertire into un'icona | Questo parametro è obbligatorio per creare un'icona immagine |
| Taglia | La dimensione dell'icona quadrata risultante | Quindi 32 si tradurrebbe in un'icona 32x32px |
| trasformare | La trasformazione da applicare all'icona risultante. L'impostazione predefinita è nessuna. |
blackandwhite - crea un'icona in bianco e nerograyscale - crea un'icona in scala di grigiinverse - inverti i colori dell'iconasepia - crea un'icona color seppia |
| source | Definire la fonte preferita di icone utilizzate in generare l'icona finita. L'impostazione predefinita è tutto. |
all - usa tutti i tipi di iconefavicon - usa solo faviconmetadata - usa solo le icone dei metadati della pagina web |
La pagina Web all'API Icon può restituire i seguenti codici di errore.
| Codice | DESCRIZIONE |
|---|---|
| 100 | Nessun URL specificato |
| 103 | Chiave dell'applicazione mancante |
| 104 | Chiave applicazione non riconosciuta |
| 114 | Dimensione icona non valida |
| 401 | Il dominio su cui viene utilizzata questa API deve essere autorizzato. |
| 500 | È richiesto un aggiornamento |