بررسی اجمالی

کتابخانه کلاینت پایتون در GitHub میزبانی می شود و بسته در PyPI در دسترس است.

نسخه 10.0.0 کتابخانه مشتری تعدادی از تغییرات رابط را معرفی کرده است که ما در بخش کتابخانه نسخه 10.0.0 مستند کرده ایم.

الزامات

کتابخانه به پایتون 3.8 یا بالاتر نیاز دارد.

پیش نیازها

قبل از نصب کتابخانه، به یک رمز توسعه دهنده و شناسه مشتری مشتری نیاز دارید. دستورالعمل نحوه به دست آوردن آنها در بخش پیش نیازها ذکر شده است. توجه داشته باشید که سایر توکن های مورد نیاز OAuth2 را در مراحل بعدی تولید خواهید کرد.

نصب و راه اندازی

دستورالعمل های موجود در اسناد نصب ما را دنبال کنید تا کتابخانه را از PyPi نصب کنید و به این صفحه بازگردید.

پیکربندی

هنگامی که کتابخانه را نصب کردید، باید یک پیکربندی برای آن تنظیم کنید. راه های مختلفی برای پیکربندی کتابخانه وجود دارد که در اسناد پیکربندی ما توضیح داده شده است.

احراز هویت

هنگامی که یک نوع پیکربندی را انتخاب کردید، می‌توانید با تولید توکن‌های OAuth2 باقی‌مانده مورد نیاز برای درخواست به API ادامه دهید. چندین جریان OAuth2 پشتیبانی شده وجود دارد که در لیست زیر مستند شده است. برای جزئیات بیشتر در مورد تفاوت‌های بین جریان‌ها و کمک به تصمیم‌گیری بهترین گزینه برای برنامه شما، به مستندات OAuth ما مراجعه کنید.

ایجاد درخواست API

هنگامی که توکن های OAuth2 خود را در پیکربندی خود قرار دادید، آماده درخواست API هستید. به مثال دریافت کمپین‌ها مراجعه کنید تا روشی ساده برای آزمایش اینکه آیا کتابخانه به‌درستی برای درخواست‌های API پیکربندی شده است.

منابع اضافی

بعد از اینکه بتوانید یک درخواست API ایجاد کنید، به این موارد از کتابخانه مشتری ادامه دهید: