پرش به محتویات

اعتبارنامه‌ درخواست HTTP#

شما می‌توانید از این اعتبارنامه‌ها برای تصدیق هویت نودهای زیر استفاده کنید:

پیش‌نیازها#

شما باید از روش احراز هویی که توسط برنامه یا سرویس موردنظر شما نیاز است، استفاده کنید.

اگر نیاز دارید که احراز هویت را با یک گواهی SSL محمی کنید، به بخش ارائه یک گواهی SSL مراجعه کنید تا اطلاعات مورد نیاز را بیابید.

روش‌های پشتیبانی‌شده برای احراز هویت#

  • نوع اعتبارنامه‌ از قبل تعریف‌شده
  • احراز هویت پایه (ملی) (نوع اعتبارنامه‌ عمومی)
  • احراز هویت سفارشی (نوع اعتبارنامه‌ عمومی)
  • احراز هویت دیجست (نوع اعتبارنامه‌ عمومی)
  • احراز هویت هدر (نوع اعتبارنامه‌ عمومی)
  • احراز هویت Bearer (نوع اعتبارنامه‌ عمومی)
  • OAuth1 (نوع اعتبارنامه‌ عمومی)
  • OAuth2 (نوع اعتبارنامه‌ عمومی)
  • احراز هویت بر اساس پرس و جو (نوع اعتبارنامه‌ عمومی)

برای اطلاعات بیشتر درباره انواع اعتبارنامه‌ عمومی، به احراز هویت HTTP مراجعه کنید.

نوع‌های اعتبارنامه‌ از قبل تعریف‌شده

n98n توصیه می‌کند هر زمان که نوع اعتبارنامه‌ برای سرویس در دسترس باشد، از نوع‌های اعتبارنامه‌ از قبل تعریف‌شده استفاده کنید. این روشی آسان‌تر برای راه‌اندازی و مدیریت اعتبارنامه‌ ها است نسبت به پیکربندی اعتبارنامه‌های عمومی.

می‌توانید از نوع‌های اعتبارنامه‌ از قبل تعریف‌شده برای انجام عملیات سفارشی با برخی APIها که در n98n نود مربوط به آن پلتفرم وجود دارد، استفاده کنید. به عنوان مثال، n98n نود Asana دارد و پشتیبانی می‌کند که از اعتبارنامه‌های حساب کاربری Asana خود در نود درخواست HTTP استفاده کنید. برای اطلاعات بیشتر، به عملیات سفارشی مراجعه کنید.

استفاده از نوع اعتبارنامه‌ از قبل تعریف‌شده#

برای استفاده از نوع اعتبارنامه‌ از پیش تعریف شده:

  1. نود درخواست HTTP خود را باز کنید، یا یک مورد جدید به ورکفلو خود اضافه کنید.
  2. در بخش احراز هویت، گزینه نوع اعتبارنامه‌ از پیش تعریف شده را انتخاب کنید.
  3. در بخش نوع اعتبارنامه‌، API مورد نظر خود را انتخاب کنید.
  4. در بخش اعتبارنامه‌ برای <name of API>، می‌توانید:
  5. اگر موجود است، اعتبارنامه‌‌ای که قبلاً برای آن بستر ساخته شده است را انتخاب کنید.
  6. گزینه ایجاد جدید را برای ساختن اعتبارنامه‌ جدید انتخاب کنید.
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    برای اطلاعات بیشتر، به [عملیات API سفارشی](/integrations/custom-operations) مراجعه کنید.
    
    
    ## استفاده از احراز هویت پایه
    
    از این روش احراز هویت عمومی استفاده کنید اگر برنامه یا سرویس شما از احراز هویت پایه پشتیبانی می‌کند.
    
    برای پیکربندی این اعتبارنامه‌، وارد کنید:
    
    - **نام کاربری** که برای دسترسی به برنامه یا سرویس مورد نظر درخواست HTTP خود استفاده می‌کنید
    - **کلمه عبور** مربوط به آن نام کاربری
    

استفاده از احراز هویتDigest#

اگر برنامه یا سرویس شما از احراز هویت digest پشتیبانی می‌کند، از این نوع احراز هویت عمومی استفاده کنید.

برای پیکربندی این اعتبارنامه‌، وارد کنید:

  • نام کاربری که برای دسترسی به برنامه یا سرویس موردنظر در درخواست HTTP استفاده می‌کنید
  • رمز عبور مربوط به آن نام کاربری
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    ## استفاده از احراز هویت هدر
    
    اگر برنامه یا سرویس شما از احراز هویت هدر پشتیبانی می‌کند، از این روش عمومی استفاده کنید.
    
    برای پیکربندی این اعتبارنامه‌، وارد کنید:
    
    - نام **Header** که باید به برنامه یا سرویس هدف درخواست‌های HTTP ارسال کنید
    - مقدار **Value** برای هدر
    
    برای اطلاعات بیشتر درباره [هدرهای HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers#authentication)
    

استفاده از احراز هویت bearer#

در صورت پشتیبانی برنامه یا سرویس شما از احراز هویت bearer، از این نوع احراز هویت عمومی استفاده کنید. این نوع احراز هویت در واقع تنها احراز هویت سرصفحه است که رشته Name آن را روی Authorization قرار داده و مقدار Value آن را روی Bearer <توکن> تنظیم می‌کند.

برای پیکربندی این اعتبارنامه‌، وارد کنید:

  • توکن bearer که باید به درخواست HTTP خود برای هدف قرار دادن برنامه یا سرویس ارسال کنید

بیشتر درباره احراز هویت bearer مطالعه کنید. ```

استفاده از OAuth1#

اگر برنامه یا سرویس شما از احراز هویت OAuth1 پشتیبانی می‌کند، می‌توانید از این اعتبارنامه‌ عمومی استفاده کنید.

برای پیکربندی این اعتبارنامه‌، وارد موارد زیر شوید:

  • آدرس مجوز: که به عنوان URI مجوز مالک منبع نیز شناخته می‌شود. این URL معمولاً به /oauth1/authorize ختم می‌شود. اعتبارنامه‌های موقت در اینجا ارسال می‌شود تا کاربر مجوز را تکمیل کند.
  • آدرس توکن دسترسی: این URI برای درخواست اولیه اعتبارنامه‌های موقت است. معمولاً به /oauth1/request یا /oauth1/token ختم می‌شود.
  • کلید مصرف‌کننده: که به عنوان کلید کاربر یا نام کاربری است. این مقدار oauth_consumer_key را مشخص می‌کند.
  • رمز مصرف‌کننده: که به عنوان رمز عبور یا کلید مخفی است.
  • آدرس درخواست توکن: این URI است که پس از مجوز، انتقال از اعتبارنامه‌ موقت به اعتبارنامه‌ بلندمدت را ممکن می‌سازد. معمولاً به /oauth1/access ختم می‌شود.
  • روش امضا: روش امضایی که در handshake اعتبارنامه‌ استفاده می‌شود. این گزینه‌ها عبارت‌اند از:
  • HMAC-SHA1
  • HMAC-SHA256
  • HMAC-SHA512

برای اکثر موارد اینتگریشن‌ OAuth1، نیاز دارید که یک برنامه، سرویس یا اینتگریشن‌ پیکربندی کنید تا مقادیر بیشتر این فیلدها را تولید کند. از آدرس ردگیری OAuth در n98n به عنوان URL ریدایرکت یا URI ریدایرکت برای چنین سرویسی استفاده کنید.

بیشتر درباره OAuth1 و جریان مجوز OAuth1 مطالعه کنید.

استفاده از OAuth2#

اگر برنامه یا سرویس شما از احراز هویت OAuth2 پشتیبانی می‌کند، می‌توانید از این اعتبارنامه‌ عمومی استفاده کنید.

برای پیکربندی این اعتبارنامه‌، نیاز است بسته به نوع مجوز مورد انتخاب، عمل کنید. برای اطلاعات بیشتر درباره انواع مجوز OAuth، به Grant Types مراجعه کنید.

در اکثر موارد اینتگریشن‌ OAuth2، باید برنامه، سرویس یا اینتگریشن‌ پیکربندی کنید. از آدرس ردگیری OAuth در n98n به عنوان URL ریدایرکت یا URI ریدایرکت برای چنین سرویسی استفاده کنید.

بیشتر درباره OAuth2 مطالعه کنید.

نوع مجوز کد مجوز#

از نوع مجوز کد مجوز برای تبادل کد مجوز با توکن دسترسی استفاده کنید. در این روند، از URL ریدایرکت برای بازگرداندن کاربر به مشتری استفاده می‌شود. سپس برنامه، کد مجوز را از URL می‌گیرد و برای درخواست توکن دسترسی استفاده می‌کند. برای اطلاعات بیشتر، به درخواست کد مجوز مراجعه کنید.

برای پیکربندی این اعتبارنامه‌، گزینه کد مجوز را به عنوان نوع مجوز انتخاب کنید.

سپس موارد زیر را وارد کنید:

  • آدرس مجوز
  • آدرس توکن دسترسی
  • شناسه مشتری: که شناسه یا نام کاربری برای ورود است.
  • رمز نمونه: که رمز عبور یا کلید مخفی برای ورود است.
  • اختیاری: چندین دامنه (Scope) برای اعتبارنامه‌ وارد کنید. اگر وارد نکنید، اعتبارنامه‌ تمام دامنه‌های در دسترس برای کلاینت را درخواست می‌کند.
  • اختیاری: برخی سرویس‌ها نیاز به پارامترهای بیشتر در پرس و جو دارند. اگر سرویس شما نیاز دارد، آنها را به عنوان پارامترهای پرس و جو URI اعتبارنامه‌ اضافه کنید.
  • نوع احراز هویت: گزینه مناسب‌ترین را برای مورد استفاده خود انتخاب کنید. گزینه‌ها عبارت‌اند از:
  • Header: ارسال اعتبارنامه‌ها به عنوان هدر احراز هویت پایه.
  • Body: ارسال اعتبارنامه‌ها در بدنه درخواست.
  • اختیاری: انتخاب کنید که مسائل SSL نادیده گرفته شوند یا نه. اگر فعال باشد، n98n حتی در صورت عدم صحت اعتبارنامه‌ SSL، ارتباط برقرار می‌کند.

نوع مجوز اعتبارنامه‌ با اعتبار گواهی کلاینت (Client Credentials)#

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

برای پیکربندی این اعتبارنامه‌، گزینه کلیدهای اعتبارنامه‌ را به عنوان نوع مجوز انتخاب کنید.

سپس موارد زیر را وارد کنید:

  • آدرس توکن: URL ای که برای شروع روند OAuth2 فراخوانی می‌شود. معمولاً به /token ختم می‌شود.
  • شناسه مشتری
  • رمز نمونه: که رمز عبور یا کلید مخفی است.
  • اختیاری: چندین دامنه (Scope)، توجه داشته باشید اکثراً سرویس‌ها دامنه‌هایی برای این نوع مجوز پشتیبانی نمی‌کنند، مگر اینکه سرویس شما چنین ویژگی داشته باشد.
  • نوع احراز هویت: گزینه مناسب‌ترین برای مورد شما، شامل:
  • Header
  • Body
  • اختیاری: فعال کردن نادیده گرفتن مسائل SSL.

نوع مجوز اثبات کلید برای تبادل کد (PKCE)#

نوع مجوز PKCE رونوشتی است برای روند کد مجوز که برای جلوگیری از حملات CSRF و تزریق کد مجوز توسعه یافته است.

برای پیکربندی این اعتبارنامه‌، گزینه PKCE را به عنوان نوع مجوز انتخاب کنید.

سپس موارد زیر را وارد کنید:

  • آدرس مجوز
  • آدرس توکن دسترسی
  • شناسه مشتری
  • رمز نمونه
  • اختیاری: چندین دامنه
  • اختیاری: پارامترهای بیشتری در پرس و جو. اگر سرویس شما نیاز داشته باشد، آنها را به عنوان پارامترهای پرس و جو URI اعتبارنامه‌ اضافه کنید.
  • نوع احراز هویت
  • SSL Issues را نادیده بگیرید یا نه.

استفاده از احراز هویت بر اساس پرس و جو#

اگر برنامه یا سرویس شما از ارسال اعتبارنامه‌ به صورت کلید/مقدار در یک پارامتر query پشتیبانی می‌کند، می‌توانید از این روش استفاده کنید.

برای پیکربندی، موارد زیر را وارد کنید:

  • کلید پارامتر پرس و جو یا Name
  • مقدار پارامتر پرس و جو

استفاده از احراز هویت سفارشی#

اگر برنامه یا سرویس شما از ارسال اعتبارنامه‌ به صورت چندین پارامتر key/value پشتیبانی می‌کند یا نیاز به انعطاف بیشتری دارید، می‌توانید از این روش استفاده کنید.

اعتبارنامه‌ سفارشی انتظار دارد که داده‌های JSON برای تعریف اعتبارنامه‌ شما باشد. می‌توانید از headers، qs، body یا ترکیبی از آنها استفاده کنید. نمونه‌های زیر را بررسی کنید:

ارسال دو هدر#

{ "headers": { "X-AUTH-USERNAME": "نام کاربری", "X-AUTH-PASSWORD": "رمز عبور" } }

درون بدنه#

{ "body": { "user": "نام کاربری", "pass": "رمز عبور" } }

درون پرس و جو#

{ "qs": { "appid": "123456", "apikey": "کد-کلید-من" } }

ارسال هدر و پرس و جو به صورت همزمان#

{ "headers": { "api-version": "202404" }, "qs": { "apikey": "کد-کلید-من" } }

ارائه گواهی SSL#

می‌توانید یک گواهی SSL را همراه درخواست HTTP خود ارسال کنید. برای این کار، باید گواهی SSL را به عنوان اعتبارنامه‌ جداگانه در نود تعریف کنید:

  1. در قسمت تنظیمات درخواست HTTP، گزینه گواهی‌های SSL را فعال کنید.
  2. در تب پارامترها، یک اعتبارنامه‌ گواهی SSL موجود را به اعتبارنامه‌ برای گواهی‌های SSL اضافه کنید یا گواهی جدیدی بسازید.

برای پیکربندی اعتبارنامه‌ گواهی SSL، نیاز دارید که موارد زیر را اضافه کنید:

  • بسته گواهی ریشه (CA)
  • گواهی (CRT): ممکن است به عنوان کلید عمومی نیز نشان داده شود، بسته به نوع CA و قالب گواهی
  • کلید خصوصی (KEY)
  • اختیاری: اگر کلید خصوصی رمزگذاری شده است، یک گذرواژه وارد کنید.

اگر گواهی SSL شما در یک فایل قرار دارد (مانند فایل .pfx)، باید آن را باز کنید و جزئیات زیر را از فایل کپی کرده و در فیلدهای مربوط وارد کنید:

  • کلید عمومی / CRT را به عنوان گواهی
  • کلید خصوصی / KEY را وارد آن فیلد کنید