دریافت توکن

👋 Introduction

توی API بیت‌پین، برای دسترسی به بعضی از مسیرها، احراز هویت ضروریه.
این بخش کمکت می‌کنه تا نحوه‌ی احراز هویت و استفاده از API Key رو به‌درستی یاد بگیری.
احراز هویت توی بیت‌پین با استفاده از توکن‌هایی که از API Key و Secret Key به دست میان، انجام می‌شه.
در اینجا شما دو نوع توکن دریافت میکنی، Refresh Token و Access Token. از Access Token برای احراز هویت درخواست ها استفاده میشه و Refresh Token برای تازه سازی و دریافت Access Token جدید استفاده میشه.

هشدار

حتماً دقت کن که Access Token بعد از 15 دقیقه و Refresh Token بعد از 30 روز اکسپایر میشن و تاریخ انقضاشون تموم میشه.

🔗 Endpoint

GET /api/v1/usr/authenticate/

⏱ Rate Limit

اطلاعیه

حداکثر تعداد درخواست‌های مجاز برای ایجاد توکن برابر با 200 درخواست در روز هست.

🔑 Creating API Key

برای شروع، به وب‌سایت یا اپلیکیشن بیت‌پین برو و بعد از ورود، به بخش API سر بزن.
توی این بخش می‌تونی یه جفت API Key و Secret Key بسازی.
همچنین باید لیستی از IP‌هایی که برای ارسال درخواست‌ها استفاده می‌کنی رو مشخص کنی.
هر API Key به یه لیست IP اختصاص داده می‌شه و درخواست‌ها فقط از این IP‌ها قابل انجامه.

هشدار

حتماً دقت کن که API Key و Secret Key رو امن نگه داری و از افشاشون جلوگیری کنی.

📨 Request

برای استفاده از API بیت‌پین، باید Token رو توی هدر درخواست ارسال کنی.
نمونه‌ای از ساختار یه درخواست با استفاده از API Key برای دریافت توکن به صورت زیره:

curl --location --request POST 'https://api.bitpin.ir/api/v1/usr/authenticate/' \  
--header 'Content-Type: application/json' \   
--data '{  
   "api_key":"YOUR_API_KEY",  
   "secret_key":"YOUR_SECRET_KEY"  
}'  

💬 Success Response

{
    "refresh": "eyJ0eXAiOiJKV....kIjoyLCJpcCI6IjE3Mi4xOC4wLjEifQ.LJd44M3...-0CiH2gokd_OWGBN3UnI",
    "access": "eyJ0eXAiOiJKV1Q....JqdGkiOiI3ZmM0YWY2ZjY1N2Y0MDU5YWRlNTY3...iNjMxZSI8UpTDxOS_utTTZW36W0KgU"
}