ממשק API של דף האינטרנט לאייקון ממיר כתובות URL into סמלים, פשוט נסה זאת הדגמה לראות את זה בפעולה. ממשק ה- API של דף האינטרנט לאייקון הוא לא סתם חוטף favicon, אלא מבסס את הסמל הסופי על כל הסמלים הזמינים לדף האינטרנט. אם אין סמלים זמינים זה יפיק אחד לדף האינטרנט. סמל המקור שנבחר, הרקע וכל גבול שנבחר יכולים להשתנות בהתאם לדרישות המשתמשים.
כדי להתחיל עם ה- API, החלף את דוגמת הטקסט של יישום המפתח בשיחה שלהלן באמצעות מפתח היישום שלך ואז קבע את פרמטר הגודל, אשר כברירת מחדל הוא 32. לבסוף ציין את דף האינטרנט שאתה רוצה להפוך into סמל, על ידי העברת כתובת האתר הנדרשת לפרמטר URL. בדוגמה הבאה https://www.tesla.com מומר into סמל פיקסל של 48x48.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com
כדאי לשמור על url פרמטר כפרמטר האחרון בשאילתהstring מכיוון שהדבר מונע את הצורך בקידוד ה- URL לרוב כתובות האתר המועברות לדף האינטרנט ל- API של אייקון.
אמנם ניתן להוריד את האייקון זה בשפה בצד השרת כגון PHP. זה יכול להיות מוצג ישירות בדף אינטרנט כמוצג להלן. זכור כי בעת השימוש ב- Icon API בדף אינטרנט יש להוסיף את התחום של דף האינטרנט לרשימה של תחומים מורשים.
<img src="//api.grabz.it/services/icon?key=Sign in to view your Application Key&size=48&url=https://www.tesla.com"/>
ניתן לשנות אייקון רק לעבור את השינוי שברצונך ליישם מהאפשרויות שלהלן. דוגמה לכך ניתן לראות כאן היה הטרנספורמציה שהופכת את האייקון שנוצר כתוצאה מכך.
//api.grabz.it/services/icon?key=Sign in to view your Application Key&transform=sepia&size=48&url=https://www.tesla.com
ממשק ה- API לדף האייקון מקבל את ארבעת הפרמטרים הבאים.
| שם | תיאור | אפשרויות |
|---|---|---|
| מפתח | מפתח היישום שלך | פרמטר זה נדרש ליצור אייקון תמונה |
| כתובת אתר | כתובת האתר של דף האינטרנט להמרה intסמל oa | פרמטר זה נדרש ליצור אייקון תמונה |
| גודל | גודל הסמל המרובע שהתקבל | אז 32 יביא לסמל 32x32px |
| לשנות | הטרנספורמציה ליישום על הסמל שהתקבל. ברירת המחדל אינה. |
blackandwhite - צור אייקון בשחור לבןgrayscale - צור אייקון בגווני אפורinverse - הפוך את צבעי הסמלsepia - צור אייקון בצבע ספיה |
| מָקוֹר | הגדירו את מקור הסמלים המועדף עליו נעשה שימוש יצירת הסמל המוגמר. ברירת המחדל היא הכל. |
all - השתמש בכל סוגי הסמליםfavicon - השתמש רק ב- faviconsmetadata - השתמש רק בסמלי המטא נתונים של דף האינטרנט |
ממשק API לדף האייקון יכול להחזיר את קודי השגיאה הבאים.
| קופונים | תיאור |
|---|---|
| 100 | לא צוינה כתובת אתר |
| 103 | מפתח היישום חסר |
| 104 | מפתח יישומים לא מזוהה |
| 114 | גודל הסמל לא חוקי |
| 401 | התחום בו משתמשים בממשק ה- API חייב להיות מורשה. |
| 500 | דרוש שדרוג |