Strona internetowa do Icon API konwertuje adresy URL into ikony, po prostu spróbuj tego próbny zobaczyć to w akcji. Interfejs API strony internetowej do ikony nie jest po prostu chwytakiem ulubionych, ale opiera ostatnią ikonę na wszystkich dostępnych ikonach strony internetowej. Jeśli żadne ikony nie są dostępne, wygeneruje je dla strony internetowej. Wybrana ikona źródła, tło i dowolna wybrana ramka mogą ulec zmianie w zależności od wymagań użytkowników.
Aby rozpocząć pracę z interfejsem API, zamień przykładowy tekst klucza APLIKACJI w poniższym wywołaniu na twój klucz aplikacji następnie ustaw parametr size, który domyślnie ma wartość 32. Na koniec określ stronę, którą chcesz włączyć into ikona, przekazując wymagany adres URL do parametru adresu URL. W poniższym przykładzie https://www.tesla.com jest konwertowany into Ikona piksela 48x48.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com
Dobrze jest zachować url parametr jako ostatni parametr w zapytaniustring ponieważ pozwala to uniknąć kodowania adresów URL większości adresów URL przekazywanych na stronę internetową do interfejsu API Icon.
Chociaż ikonę można pobrać za pomocą języka po stronie serwera, takiego jak PHP. Można go również wyświetlić bezpośrednio na stronie internetowej, jak pokazano poniżej. Pamiętaj, że gdy używasz Icon API na stronie internetowej, domena strony musi zostać dodana do listy autoryzowane domeny.
<img src="//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com"/>
Ikonę można również przekształcić, po prostu przekaż transformację, którą chcesz zastosować, z poniższych opcji. Przykładem, który można tu zobaczyć, jest to, że transformacja sprawia, że uzyskana ikona jest sepia.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&transform=sepia&size=48&url=https://www.tesla.com
Interfejs API strony internetowej do Icon akceptuje następujące cztery parametry.
| Imię lub Nazwa Firmy | Opis | Opcje |
|---|---|---|
| klucz | Twój klucz aplikacji | Ten parametr jest wymagany aby utworzyć ikonę obrazu |
| url | Adres URL strony do konwersji into ikona | Ten parametr jest wymagany aby utworzyć ikonę obrazu |
| rozmiar | Rozmiar wynikowej ikony kwadratu | Tak więc 32 spowoduje wyświetlenie ikony 32x32px |
| przekształcać | Przekształcenie stosowane do wynikowej ikony. Domyślna wartość to none. |
blackandwhite - utwórz czarno-białą ikonęgrayscale - utwórz ikonę w skali szarościinverse - odwróć kolory ikonysepia - utwórz ikonę w kolorze sepii |
| źródło | Zdefiniuj preferowane źródło ikon używanych w generowanie gotowej ikony. Domyślnie jest wszystko. |
all - użyj wszystkich rodzajów ikonfavicon - używaj tylko ulubionychmetadata - używaj tylko ikon metadanych strony internetowej |
Interfejs API strony internetowej może zwrócić następujące kody błędów.
| Kod | Opis |
|---|---|
| 100 | Nie określono adresu URL |
| 103 | Brak klucza aplikacji |
| 104 | Nierozpoznany klucz aplikacji |
| 114 | Nieprawidłowy rozmiar ikony |
| 401 | Domena, w której używany jest interfejs API, musi być upoważniony. |
| 500 | Wymagana jest aktualizacja |