بخش‌های مستندات
API و یکپارچه‌سازی۶ دقیقه مطالعهبه‌روز شده: ۵ اردیبهشت ۱۴۰۳

احراز هویت API

API پازل از OAuth 2.0 با Bearer token استفاده می‌کند. هر درخواست باید یک Authorization header معتبر داشته باشد.

مرور کلی

برای استفاده از API، ابتدا باید یک access token بگیرید. توکن‌ها دو نوع هستند: personal access token (برای توسعه و تست) و service token (برای محیط تولید).

دریافت access token

از پنل کاربری، وارد بخش «توسعه‌دهندگان» > «API Tokens» شوید. روی «ساخت توکن جدید» کلیک کنید و دامنه دسترسی را تعیین کنید.

httpپازل API
POST https://api.puzzle.ir/v1/auth/token
Content-Type: application/json

{
  "grant_type": "client_credentials",
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "scope": "read write"
}

# Response
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6...",
  "token_type": "Bearer",
  "expires_in": 3600
}

استفاده از token

httpپازل API
GET https://api.puzzle.ir/v1/records
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...
Content-Type: application/json

تجدید token

توکن‌های access بعد از یک ساعت منقضی می‌شوند. برای تجدید، از refresh token استفاده کنید:

httpپازل API
POST https://api.puzzle.ir/v1/auth/token
Content-Type: application/json

{
  "grant_type": "refresh_token",
  "refresh_token": "your-refresh-token"
}

امنیت توکن

هرگز access token را در کد frontend یا repository عمومی قرار ندهید. از متغیرهای محیطی (env variables) استفاده کنید.