اتصال به API
این API از OAuth1، OAuth2 و همچنین نام کاربری و رمز عبور برای احراز هویت پشتیبانی میکند، و به جای رمز عبور میتوان از کلید دسترسی نیز استفاده کرد. در حالی که مستندات عمدتاً OAuth2 و احراز هویت پایه را پوشش میدهد، API از OAuth2 برای تمامی ۴ نوع اعطا پشتیبانی میکند. برای امنیت پیشرفته، میتوان تنظیمات OAuth را به گونهای پیکربندی کرد که فقط به برخی از نقاط پایانی و پارامترها دسترسی داده شود.
نمونه کد - احراز هویت OAuth2
در این مثال، نحوه ورود به سیستم با OAuth2 و انجام برخی درخواستهای نمونه به API نشان داده شده است. از کتابخانههای requests و requests_oauthlib برای اتصال به API استفاده شده است. توجه داشته باشید که این فقط یک مثال است و پیادهسازی واقعی ممکن است بسته به نیازهای خاص تغییر کند.ابتدا باید کتابخانههای مورد نیاز را نصب کنید:
API به عنوان یک فریمورک
REST API همچنین به عنوان یک چارچوب طراحی شده است و می تواند به عنوان پایه ای برای یک برنامه افزودنی متناسب با نیازهای فردی استفاده شود. این مثال کد نشان می دهد که تعیین نقطه پایانی چقدر آسان است. پارامترها در @api_docs حاشیه نویسی اختیاری هستند. اگر هیچ پارامتری داده نشود، مقادیر پیشفرض پویا براساس امضای تابع تولید میشوند.
مشتریان
تقریباً در هر زبان برنامه نویسی، کلاینت های REST بسیار خوبی وجود دارد. به عنوان مثال، در پایتون کتابخانه Requests برای برقراری تماس های HTTP و Requests-OAuthlib برای احراز هویت با OAuth وجود دارد، فقط یکی را نام برد.
اما اگر می خواهید مشتری خود را ایجاد کنید، می توانید به طور خودکار بر اساس اسناد API یک مشتری ایجاد کنید. مشتری توسط Swagger CodeGen ایجاد شده است و می تواند به عنوان یک نقطه شروع خوب باشد.
مشخصات
version | 16 یا 17 یا 15 |