API למפתחים

ה-API למפתחים של Guidez מאפשר לאתר של יוצר/ת להציג את המפות שלהם ולדווח איך הן נמכרות. השרת שלכם קורא לו עם מפתח API. הוא מחזיר תצוגה מקדימה של כל מפה (כותרת, תיאור, תמונת שער, מחיר וקישור לדף הנחיתה) ואת המכירות של כל מפה לאורך זמן.

ה-API מיועד לקריאה בלבד. כדי למכור מפה באתר, המשיכו להשתמש בהטמעה מהטאב אינטגרציה לאתר.

קבלת מפתח API

1. היוצר/ת מזמינים אתכם מאינטגרציה לאתר בפורטל היוצרים, או עובדים על זה בעצמם.
2. התחברו ל-web.guidez.app ופתחו את API למפתחים בפורטל.
3. הזינו שם למפתח, למשל האתר הראשי, ובחרו צור מפתח.
4. העתיקו את המפתח. הוא מתחיל ב-gz_live_ ומוצג פעם אחת בלבד.
5. שמרו אותו כסוד בשרת שלכם, למשל במשתנה סביבה בשם GUIDEZ_API_KEY.

הטאב API למפתחים עם מפתח חדש ורשימת המפתחות/screenshots/developer-api-keys.png

הבקשה הראשונה

curl https://api.guidez.app/developer-api/v1/maps \
  -H "Authorization: Bearer $GUIDEZ_API_KEY"

תקבלו את המפות שהיוצר/ת פרסמו. כל נקודות הקצה מופיעות במדריך ה-API.

שמירה על המפתח

• בשרת בלבד. אל תשימו את המפתח בקוד של הדפדפן, באפליקציה או במאגר קוד. דפדפנים חסומים מלקרוא ל-API, וכל מי שמחזיק את המפתח יכול לקרוא את המפות והמכירות של היוצר/ת.
• החלפה בלי השבתה. צרו מפתח חדש, העלו אותו לשרת, ואז בחרו בטל ליד הישן. שניהם עובדים עד שמבטלים.
• איבדתם מפתח? Guidez לא שומרת עותק קריא שלו, ולכן אי אפשר להציג אותו שוב. צרו מפתח חדש ובטלו את הישן.
• הגישה נגמרת עם ההזמנה. כשהיוצר/ת מסירים אתכם, כל המפתחות שיצרתם מפסיקים לעבוד.

מגבלות

• עד 120 בקשות בדקה לכל מפתח. מעבר לזה מקבלים 429 עם כותרת Retry-After.
• עד 10 מפתחות פעילים לכל יוצר/ת.
• שמרו תשובות במטמון לכמה דקות, במקום לקרוא ל-API בכל צפייה בעמוד.