סקירה כללית

ספריית הלקוח של Python מתארחת ב-GitHub, והחבילה זמינה ב-PyPI.

גרסה 10.0.0 של ספריית הלקוח כוללת כמה שינויים בממשק שתיעדנו בקטע גרסה 10.0.0 של הספרייה.

דרישות

בספרייה צריך להשתמש ב-Python מגרסה 3.8 ואילך.

דרישות מוקדמות

לפני התקנת הספרייה, תצטרכו קוד מפתח ומזהה לקוח. ההוראות לקבלת השובר מפורטות בקטע דרישות מוקדמות. שימו לב: יוצרים את אסימוני OAuth2 האחרים שנדרשים בשלבים הבאים.

התקנה

פועלים לפי ההוראות במסמכי ההתקנה כדי להתקין את הספרייה מ-PyPi ולחזור לדף הזה.

הגדרות אישיות

אחרי שמתקינים את הספרייה, צריך להגדיר עבורה הגדרות אישיות. יש כמה דרכים להגדיר את הספרייה, והן מתוארות במאמרי העזרה בנושא הגדרות אישיות.

אימות

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

• תהליך עבודה של אפליקציות OAuth למחשב
• תהליך אפליקציית אינטרנט של OAuth
• תהליך העבודה בחשבון שירות של OAuth

שליחת בקשה ל-API

אחרי שמשלבים את אסימוני OAuth2 בהגדרות, אפשר לשלוח בקשת API. דרך פשוטה לבדוק שהספרייה מוגדרת כראוי לשליחת בקשות API אפשר לעיין בדוגמה לקבלת קמפיינים.

מקורות מידע נוספים

אחרי שאפשר לשלוח בקשת API, ממשיכים להשתמשים הבאים בספריית הלקוח:

• רישום ביומן
• מסכות שדה
• שמות משאבים
• מאחזרים של פרוטו
• הגדרת שדות הודעה ריקים