De Webpage to Icon API converteert URL's into pictogrammen, probeer dit gewoon eens demonstratie om het in actie te zien. De Webpage to Icon API is niet zomaar een favicon grabber, maar baseert in plaats daarvan het uiteindelijke pictogram op alle beschikbare iconen voor de webpagina. Als er geen pictogrammen beschikbaar zijn, wordt er een voor de webpagina gegenereerd. Het gekozen bronpictogram, de achtergrond en elke geselecteerde rand kunnen veranderen afhankelijk van de vereisten van de gebruiker.
Om aan de slag te gaan met de API, vervangt u het tekstvoorbeeld APPLICATION KEY in de onderstaande oproep door uw applicatiesleutel stel vervolgens de grootteparameter in, die standaard op 32 staat. Geef ten slotte de webpagina op die u wilt omslaan into een pictogram, door de vereiste URL door te geven aan de URL-parameter. In het volgende voorbeeld https://www.astropioneer.blog/ wordt omgezet intoa 48x48 pixel icoon.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.astropioneer.blog/
Het is een goed idee om de url parameter als laatste parameter in de querystring omdat dit voorkomt dat URL's moeten worden gecodeerd voor de meeste URL's die worden doorgegeven aan de Webpage to Icon API.
Hoewel het pictogram kan worden gedownload met een serverside-taal zoals PHP. Het kan ook rechtstreeks op een webpagina worden weergegeven of in JavaScript worden gebruikt, zoals hieronder weergegeven. Houd er rekening mee dat bij gebruik van de Icon API in een webpagina het domein van de webpagina moet worden toegevoegd aan de lijst met geautoriseerde domeinen.
<img src="//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.astropioneer.blog/"/>
<script>
fetch('https://api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.astropioneer.blog/')
.then(response => response.blob())
.then(blob => {
console.log(blob);
});
</script>
Een pictogram kan ook worden getransformeerd, geef gewoon de transformatie door die u wilt toepassen uit de onderstaande opties. Een voorbeeld hiervan is hier te zien waar de transformatie het resulterende pictogram sepia maakt.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&transform=sepia&size=48&url=https://www.astropioneer.blog/
De Webpage to Icon API accepteert de volgende vier parameters.
| Naam | Omschrijving | Opties |
|---|---|---|
| sleutel | Uw toepassingssleutel | Deze parameter is vereist om een afbeeldingspictogram te maken |
| url | De URL van de webpagina die moet worden geconverteerd intoa icoon | Deze parameter is vereist om een afbeeldingspictogram te maken |
| grootte | De grootte van het resulterende vierkante pictogram | Dus 32 zou resulteren in een pictogram van 32x32px |
| transformeren | De transformatie die moet worden toegepast op het resulterende pictogram. De standaard is geen. |
blackandwhite - maak een zwart-wit pictogramgrayscale - maak een grijswaardenpictograminverse - keer de kleuren van het pictogram omsepia - maak een sepia gekleurd pictogram |
| (bron) | Definieer de voorkeursbron van pictogrammen die worden gebruikt in het genereren van het voltooide pictogram. De standaard is alles. |
all - gebruik alle soorten pictogrammenfavicon - gebruik alleen faviconsmetadata - gebruik alleen de metadata-iconen van de webpagina |
De Webpage to Icon API kan de volgende foutcodes retourneren.
| Code | Omschrijving |
|---|---|
| 100 | Geen URL opgegeven |
| 103 | Applicatiesleutel ontbreekt |
| 104 | Niet-herkende toepassingssleutel |
| 114 | Pictogramgrootte ongeldig |
| 401 | Het domein waarop deze API wordt gebruikt, moet zijn bevoegd. |
| 500 | Een upgrade is vereist |