احراز هویت API

n98n از کلیدهای API برای احراز هویت فراخوانی‌های API استفاده می‌کند.

دسترسی به ویژگی

API n98n در دوره آزمایشی رایگان در دسترس نیست. لطفاً برای دسترسی به این ویژگی ارتقا دهید.

API Scopes

کاربران اینستنس‌های سازمانی می‌توانند با استفاده از محدوده‌ها، منابع و اقداماتی که یک کلید می‌تواند به آن‌ها دسترسی داشته باشد را محدود کنند. محدوده‌های کلید API به شما امکان می‌دهد سطح دقیق دسترسی مورد نیاز یک کلید را برای هدف مورد نظر مشخص کنید.

کلیدهای API غیر سازمانی دسترسی کامل به تمام منابع و قابلیت‌های حساب دارند.

ایجاد یک کلید API

1. وارد n98n شوید.
2. به تنظیمات > API n98n بروید.
3. ایجاد کلید API را انتخاب کنید.
4. یک برچسب انتخاب کنید و زمان انقضا را برای کلید تنظیم کنید.
5. اگر در پلن سازمانی هستید، محدوده‌ها را برای اعطای دسترسی به کلید انتخاب کنید.
6. کلید API من را کپی کنید و از این کلید برای احراز هویت فراخوانی‌های خود استفاده کنید.

فراخوانی API با استفاده از کلید خود

کلید API را در فراخوانی API خود به عنوان هدری به نام X-N8N-API-KEY ارسال کنید.

برای مثال، فرض کنید می‌خواهید تمام ورکفلوها فعال را دریافت کنید. درخواست curl شما به این شکل خواهد بود:

# برای یک اینستنس n98n خود میزبان
curl -X 'GET' \
  '<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

# برای n98n Cloud
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

حذف یک کلید API

1. وارد n98n شوید.
2. به تنظیمات > API n98n بروید.
3. حذف را در کنار کلیدی که می‌خواهید حذف کنید انتخاب کنید.
4. با انتخاب حذف برای همیشه حذف را تأیید کنید.