การใช้งาน HTTP Request

เรียนรู้วิธีใช้ node คำขอ HTTP ใน n8n ปฏิบัติตามเอกสารทางเทคนิคเพื่อรวม node คำขอ HTTP เข้ากับ workflow ของคุณ

node คำขอ HTTP เป็นหนึ่งใน node ที่หลากหลายที่สุดใน n8n ช่วยให้คุณสามารถส่งคำขอ HTTP เพื่อสืบค้นข้อมูลจากแอปหรือบริการใดๆ ด้วย REST API คุณสามารถใช้ node คำขอ HTTP เป็น node ปกติหรือแนบไปกับไฟล์ Tools Agent เพื่อใช้เป็น เครื่องมือ .

เมื่อใช้ node นี้ คุณกำลังสร้างการเรียก REST API คุณต้องมีความเข้าใจเกี่ยวกับคำศัพท์และแนวคิดพื้นฐานของ API

คุณสามารถสร้างคำขอ HTTP ได้สองวิธี: กำหนดค่า parameter node หรือ นำเข้าคำสั่ง curl .

Credentials

อ้างถึง HTTP Request credentials สำหรับคำแนะนำในการตั้งค่าการรับรองความถูกต้อง

parameter node

Method

เลือกวิธีการใช้สำหรับคำขอ:

• ลบ
• ได้รับ
• หัว
• ตัวเลือก
• แพตช์
• โพสต์
• ใส่

URL

ป้อนตำแหน่งข้อมูลที่คุณต้องการใช้

Authentication

n8n แนะนำให้ใช้ Predefined Credential Type ตัวเลือกเมื่อมีให้ นำเสนอวิธีที่ง่ายกว่าในการตั้งค่าและจัดการข้อมูลประจำตัว เมื่อเทียบกับการกำหนดค่า credentials ทั่วไป

credentials ที่กำหนดไว้ล่วงหน้า (Predefined credentials)

credentials สำหรับการผสานรวมที่รองรับโดย n8n รวมถึง node ทั้งในตัวและ node ชุมชน ใช้ Predefined Credential Type สำหรับการดำเนินการแบบกำหนดเองโดยไม่ต้องตั้งค่าเพิ่มเติม อ้างถึง Custom API actions for existing nodes สำหรับข้อมูลเพิ่มเติม

credentials ทั่วไป (Generic credentials)

credentials สำหรับการผสานรวมไม่รองรับโดย n8n คุณจะต้องกำหนดค่ากระบวนการตรวจสอบสิทธิ์ด้วยตนเอง รวมถึงการระบุจุดสิ้นสุด API ที่จำเป็น parameter ที่จำเป็น และวิธีการตรวจสอบสิทธิ์

คุณสามารถเลือกวิธีใดวิธีหนึ่งต่อไปนี้:

• การรับรองความถูกต้องขั้นพื้นฐาน
• การรับรองความถูกต้องที่กำหนดเอง
• รับรองความถูกต้องแบบแยกย่อย
• การรับรองความถูกต้องส่วนหัว
• OAuth1 API
• OAuth2 API
• สอบถามการตรวจสอบสิทธิ์
• การรับรองความถูกต้องแบบกำหนดเองแบบง่าย

อ้างถึง HTTP Request credentials สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการตั้งค่า credentials แต่ละประเภท

Send Query Parameters

parameter การค้นหาทำหน้าที่เป็นตัวกรองคำขอ HTTP หาก API ที่คุณกำลังโต้ตอบด้วยรองรับและคำขอที่คุณกำลังดำเนินการจำเป็นต้องมีตัวกรอง ให้เปิดตัวเลือกนี้

ระบุ parameter การสืบค้นของคุณ (Specify your query parameters) โดยใช้หนึ่งในตัวเลือกที่มีอยู่:

• Using Fields Below : เข้า Name/Value คู่ของ Query Parameters . หากต้องการป้อนคู่ชื่อ/ค่า parameter การสืบค้นเพิ่มเติม ให้เลือก Add Parameter . ชื่อคือชื่อของฟิลด์ที่คุณกำลังกรอง และค่าคือค่าตัวกรอง
• Using JSON : เข้า JSON เพื่อกำหนด parameter การค้นหาของคุณ

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

Send Headers

ใช้ parameter นี้เพื่อส่งส่วนหัวพร้อมกับคำขอของคุณ ส่วนหัวมีข้อมูลเมตาหรือบริบทเกี่ยวกับคำขอของคุณ

Specify Headers โดยใช้หนึ่งในตัวเลือกที่มีอยู่:

• Using Fields Below : เข้า Name/Value คู่ของ Header Parameters . หากต้องการป้อนคู่ชื่อ/ค่า parameter ส่วนหัวเพิ่มเติม ให้เลือก Add Parameter . ชื่อคือส่วนหัวที่คุณต้องการตั้งค่า และค่าคือค่าที่คุณต้องการส่งผ่านสำหรับส่วนหัวนั้น
• Using JSON : เข้า JSON เพื่อกำหนด parameter ส่วนหัวของคุณ

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

Send Body

หากคุณต้องการส่งเนื้อหาพร้อมกับคำขอ API ให้เปิดตัวเลือกนี้

จากนั้นเลือก Body Content Type ที่ตรงกับรูปแบบของเนื้อหาเนื้อหาที่คุณต้องการส่งมากที่สุด

Form URLencoded

ใช้ตัวเลือกนี้เพื่อส่งร่างกายของคุณเป็น application/x-www-form-urlencoded.

Specify Body โดยใช้หนึ่งในตัวเลือกที่มีอยู่:

• Using Fields Below : เข้า Name/Value คู่ของ Body Parameters . หากต้องการป้อนคู่ชื่อ/ค่า parameter เนื้อหาเพิ่มเติม ให้เลือก Add Parameter . ชื่อควรเป็นชื่อฟิลด์ของฟอร์ม และค่าคือสิ่งที่คุณต้องการตั้งค่าฟิลด์นั้น
• Using Single Field : ป้อนคู่ชื่อ/ค่าของคุณในคู่เดียว Body parameter ที่มีรูปแบบ fieldname1=value1&fieldname2=value2.

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

Form-Data

ใช้ตัวเลือกนี้เพื่อส่งร่างกายของคุณเป็น multipart/form-data.

กำหนดค่าของคุณ Body Parameters โดยการเลือก Parameter Type:

• เลือก Form Data เพื่อเข้า Name/Value คู่
• เลือก ไฟล์ไบนารี n8n (n8n Binary File) เพื่อดึงเนื้อหาออกจากไฟล์ที่ node สามารถเข้าถึงได้
  • Name : กรอก ID ของช่องที่จะตั้งค่า
  • Input Data Field Name : ป้อนชื่อของฟิลด์ขาเข้าที่มีข้อมูลไฟล์ไบนารีที่คุณต้องการประมวลผล

เลือก Add Parameter เพื่อป้อน parameter เพิ่มเติม

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

JSON

ใช้ตัวเลือกนี้เพื่อส่งร่างกายของคุณเป็น JSON

Specify Body โดยใช้หนึ่งในตัวเลือกที่มีอยู่:

• Using Fields Below : เข้า Name/Value คู่ของ Body Parameters . หากต้องการป้อนคู่ชื่อ/ค่า parameter เนื้อหาเพิ่มเติม ให้เลือก Add Parameter.
• Using JSON : เข้า JSON เพื่อกำหนดร่างกายของคุณ

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

ไฟล์ไบนารี n8n (n8n Binary File)

ใช้ตัวเลือกนี้เพื่อส่งเนื้อหาของไฟล์ที่เก็บไว้ใน n8n เป็นเนื้อหา

ป้อนชื่อของฟิลด์ขาเข้าที่มีไฟล์เป็น Input Data Field Name.

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียดเกี่ยวกับวิธีการจัดรูปแบบไฟล์

Raw

ใช้ตัวเลือกนี้เพื่อส่งข้อมูลดิบในร่างกาย

• Content Type : ป้อน Content-Type ส่วนหัวเพื่อใช้สำหรับเนื้อหาเนื้อหาดิบ อ้างอิงถึง IANA ประเภทสื่อ เอกสารประกอบสำหรับรายการประเภทเนื้อหา MIME ทั้งหมด
• Body : ป้อนเนื้อหาดิบที่จะส่ง

โปรดดูเอกสารประกอบ API ของบริการของคุณสำหรับคำแนะนำโดยละเอียด

ตัวเลือก node

เลือก Add Option เพื่อดูและเลือกตัวเลือกเหล่านี้ ตัวเลือกใช้ได้กับ parameter ทั้งหมด เว้นแต่จะระบุไว้เป็นอย่างอื่น

Array Format in Query Parameters

ความพร้อมของตัวเลือก (Option availability)

ตัวเลือกนี้จะใช้ได้เฉพาะเมื่อคุณเปิดเครื่องเท่านั้น Send Query Parameters.

ใช้ตัวเลือกนี้เพื่อควบคุมรูปแบบของ array ที่รวมอยู่ใน parameter การสืบค้น เลือกจากตัวเลือกเหล่านี้:

• No Brackets : array จะจัดรูปแบบเป็นชื่อ=ค่าสำหรับแต่ละรายการใน array ตัวอย่างเช่น: foo=bar&foo=qux.
• Brackets Only : node จะเพิ่มวงเล็บเหลี่ยมหลังชื่อ array แต่ละตัว เช่น: foo[]=bar&foo[]=qux.
• Brackets with Indices : node จะเพิ่มวงเล็บเหลี่ยมที่มีค่าดัชนีหลังชื่อ array แต่ละตัว เช่น: foo[0]=bar&foo[1]=qux.

โปรดดูเอกสารประกอบ API ของบริการของคุณเพื่อดูคำแนะนำว่าควรใช้ตัวเลือกใด

Batching

ควบคุมวิธีการแบทช์รายการ input จำนวนมาก:

• Items per Batch : ป้อนจำนวนรายการ input ที่จะรวมในแต่ละชุด
• Batch Interval : ป้อนเวลาที่รอระหว่างคำขอแต่ละชุดในหน่วยมิลลิวินาที ป้อน 0 โดยไม่มีช่วงเวลาแบทช์

Ignore SSL Issues

ตามค่าเริ่มต้น n8n จะดาวน์โหลดการตอบสนองหากการตรวจสอบใบรับรอง SSL สำเร็จเท่านั้น หากคุณต้องการดาวน์โหลดการตอบกลับแม้ว่าการตรวจสอบใบรับรอง SSL จะล้มเหลว ให้เปิดตัวเลือกนี้

Lowercase Headers

เลือกว่าจะใช้ชื่อส่วนหัวเป็นตัวพิมพ์เล็ก (เปิดอยู่ เป็นค่าเริ่มต้น) หรือไม่ (ปิดอยู่)

Redirects

เลือกว่าจะติดตามการเปลี่ยนเส้นทาง (เปิดตามค่าเริ่มต้น) หรือไม่ (ปิด) หากเปิดใช้งาน ให้ป้อนจำนวนการเปลี่ยนเส้นทางสูงสุดที่คำขอควรติดตาม Max Redirects.

Response

ใช้ตัวเลือกนี้เพื่อกำหนดรายละเอียดบางอย่างเกี่ยวกับการตอบสนองของ API ที่คาดหวัง ซึ่งรวมถึง:

• Include Response Headers and Status : ตามค่าเริ่มต้น node จะส่งคืนเฉพาะเนื้อหาเท่านั้น เปิดตัวเลือกนี้เพื่อส่งคืนการตอบกลับแบบเต็ม (ส่วนหัวและรหัสสถานะการตอบกลับ) รวมถึงเนื้อหา
• Never Error : ตามค่าเริ่มต้น node จะส่งคืนความสำเร็จก็ต่อเมื่อการตอบกลับส่งคืนด้วยรหัส 2xx เปิดตัวเลือกนี้เพื่อคืนความสำเร็จโดยไม่คำนึงถึงรหัสที่ส่งคืน
• Response Format : เลือกรูปแบบที่จะส่งข้อมูลกลับ เลือกจาก:
  • Autodetect (ค่าเริ่มต้น): node ตรวจจับและจัดรูปแบบการตอบสนองตามข้อมูลที่ส่งคืน
  • File : เลือกตัวเลือกนี้เพื่อใส่การตอบกลับลงในไฟล์ ป้อนชื่อฟิลด์ที่คุณต้องการให้ไฟล์ส่งคืน Put Output in Field.
  • JSON : เลือกตัวเลือกนี้เพื่อจัดรูปแบบการตอบกลับเป็น JSON
  • Text : เลือกตัวเลือกนี้เพื่อจัดรูปแบบการตอบกลับเป็นข้อความธรรมดา ป้อนชื่อฟิลด์ที่คุณต้องการให้ไฟล์ส่งคืน Put Output in Field.

Pagination

ใช้ตัวเลือกนี้เพื่อแบ่งหน้าผลลัพธ์ ซึ่งมีประโยชน์ในการจัดการผลลัพธ์การสืบค้นที่มีขนาดใหญ่เกินกว่าที่ API จะส่งกลับในการเรียกครั้งเดียว

ตรวจสอบข้อมูล API ก่อน (Inspect the API data first)

ตัวเลือกบางอย่างสำหรับ pagination ต้องอาศัยความรู้เกี่ยวกับข้อมูลที่ส่งคืนโดย API ที่คุณใช้ ก่อนตั้งค่า pagination ให้ตรวจสอบเอกสาร API หรือทำการเรียก API โดยไม่มี pagination เพื่อดูข้อมูลที่ส่งคืน

กำหนดการตั้งค่า pagination:

• Pagination Mode:
  • Off : ปิด pagination
  • Update a Parameter in Each Request : ใช้สิ่งนี้เมื่อคุณต้องการตั้งค่า parameter แบบไดนามิกสำหรับแต่ละคำขอ
  • Response Contains Next URL : ใช้สิ่งนี้เมื่อการตอบสนองของ API รวม URL ของหน้าถัดไป ใช้ expression ในการตั้งค่า Next URL.

ตัวอย่างเช่น การตั้งค่า โปรดดูที่ ตำราอาหาร node คำขอ HTTP | pagination .

n8n จัดเตรียมตัวแปรในตัวสำหรับการทำงานกับคำขอและการตอบกลับของ node HTTP เมื่อใช้ pagination:

ความแตกต่างของ API (API differences)

API ที่แตกต่างกันใช้ pagination ในรูปแบบที่แตกต่างกัน ตรวจสอบเอกสารประกอบ API สำหรับ API ที่คุณใช้เพื่อดูรายละเอียด คุณต้องค้นหาสิ่งต่าง ๆ เช่น:

• API ให้ URL สำหรับหน้าถัดไปหรือไม่
• มีการจำกัดขนาดหน้าหรือหมายเลขหน้าเฉพาะ API หรือไม่
• โครงสร้างของข้อมูลที่ API ส่งคืน

Proxy

ใช้ตัวเลือกนี้หากคุณต้องการระบุพร็อกซี HTTP

ป้อน Proxy คำขอควรใช้ ซึ่งจะมีความสำคัญเหนือกว่าการตั้งค่าส่วนกลางที่กำหนดด้วย HTTP_PROXY, HTTPS_PROXY หรือ ALL_PROXY ตัวแปรสภาพแวดล้อม .

Timeout

ใช้ตัวเลือกนี้เพื่อกำหนดระยะเวลาที่ node ควรรอให้เซิร์ฟเวอร์ส่งส่วนหัวการตอบกลับ (และเริ่มต้นเนื้อหาการตอบกลับ) node จะยกเลิกการร้องขอที่เกินค่านี้สำหรับการตอบกลับครั้งแรก

ป้อน Timeout เวลาที่ต้องรอเป็นมิลลิวินาที

ตัวเลือกเครื่องมือเท่านั้น

ตัวเลือกต่อไปนี้ใช้ได้เฉพาะเมื่อแนบไปกับ Tools Agent เป็น เครื่องมือ .

Optimize Response

ไม่ว่าจะปรับการตอบสนองของเครื่องมือให้เหมาะสมเพื่อลดปริมาณข้อมูลที่ส่งไปยัง LLM หรือไม่ การเพิ่มประสิทธิภาพการตอบสนองสามารถลดต้นทุนและช่วยให้ LLM เพิกเฉยต่อรายละเอียดที่ไม่สำคัญ ซึ่งมักจะนำไปสู่ผลลัพธ์ที่ดีกว่า

เมื่อปรับการตอบสนองให้เหมาะสม คุณจะต้องเลือกประเภทการตอบสนองที่ต้องการ ซึ่งจะกำหนดตัวเลือกอื่นๆ ที่คุณสามารถกำหนดค่าได้ ประเภทการตอบกลับที่รองรับคือ:

JSON

เมื่อคาดหวังก JSON การตอบสนอง คุณสามารถกำหนดค่าว่าส่วนใดของข้อมูล JSON ที่จะใช้เป็นการตอบกลับด้วยตัวเลือกต่อไปนี้:

• Field Containing Data : ช่องนี้ระบุส่วนเฉพาะของ object JSON ที่มีข้อมูลที่เกี่ยวข้องของคุณ คุณสามารถเว้นว่างไว้เพื่อใช้การตอบกลับทั้งหมด
• Include Fields : นี่คือวิธีที่คุณเลือกฟิลด์ที่คุณต้องการใน object การตอบกลับของคุณ มีสามทางเลือก:
  • All : รวมทุกช่องใน object การตอบกลับ
  • Selected : รวมเฉพาะฟิลด์ที่ระบุด้านล่าง
    • Fields : รายการช่องที่คั่นด้วยเครื่องหมายจุลภาคที่จะรวมไว้ในการตอบกลับ คุณสามารถใช้เครื่องหมายจุดเพื่อระบุฟิลด์ที่ซ้อนกันได้ คุณสามารถลากฟิลด์จากแผงป้อนข้อมูลเพื่อเพิ่มลงในรายการฟิลด์ได้
  • Exclude : รวมทุกช่อง ยกเว้น ฟิลด์ที่ระบุด้านล่าง
    • Fields : รายการช่องที่คั่นด้วยเครื่องหมายจุลภาคที่จะยกเว้นจากการตอบกลับ คุณสามารถใช้เครื่องหมายจุดเพื่อระบุฟิลด์ที่ซ้อนกันได้ คุณสามารถลากฟิลด์จากแผงป้อนข้อมูลเพื่อเพิ่มลงในรายการฟิลด์ได้

HTML

เมื่อคาดหวัง HTML คุณสามารถระบุส่วนของเอกสาร HTML ที่เกี่ยวข้องกับ LLM และปรับการตอบสนองให้เหมาะสมด้วยตัวเลือกต่อไปนี้:

• Selector (CSS) : องค์ประกอบเฉพาะหรือประเภทองค์ประกอบที่จะรวมไว้ใน HTML ตอบกลับ ใช้ body องค์ประกอบตามค่าเริ่มต้น
• Return Only Content : ว่าจะตัดแท็ก HTML และแอตทริบิวต์ออกจากการตอบกลับหรือไม่ โดยเหลือเพียงเนื้อหาจริงเท่านั้น วิธีนี้ใช้ token น้อยลงและอาจเข้าใจง่ายกว่าสำหรับโมเดล
  • Elements To Omit : รายการตัวเลือก CSS ที่คั่นด้วยเครื่องหมายจุลภาคเพื่อแยกออกเมื่อแยกเนื้อหา
• Truncate Response : จะจำกัดขนาดการตอบสนองเพื่อบันทึก token หรือไม่
  • Max Response Characters : จำนวนอักขระสูงสุดที่จะรวมในการตอบกลับ HTML ค่าเริ่มต้นคือ 1,000

Text

เมื่อคาดหวังแบบทั่วไป Text การตอบสนอง คุณสามารถปรับผลลัพธ์ให้เหมาะสมด้วยตัวเลือกต่อไปนี้:

• Truncate Response : จะจำกัดขนาดการตอบสนองเพื่อบันทึก token หรือไม่
  • Max Response Characters : จำนวนอักขระสูงสุดที่จะรวมในการตอบกลับ HTML ค่าเริ่มต้นคือ 1,000

นำเข้าคำสั่ง curl

ขด เป็นเครื่องมือบรรทัดคำสั่งและไลบรารีสำหรับการถ่ายโอนข้อมูลด้วย URL

คุณสามารถใช้ curl เพื่อเรียก REST API หากเอกสารประกอบ API ของบริการที่คุณต้องการใช้มีตัวอย่าง Curl คุณสามารถคัดลอกเอกสารเหล่านั้นออกจากเอกสารประกอบและลงใน n8n เพื่อกำหนดค่า node คำขอ HTTP

นำเข้าคำสั่ง curl:

รูปแบบการนำเข้า (Import format)

ตัวเลือกนี้จะนำเข้าค่า parameter ใดๆ เป็น string เสมอ หากต้องการคงตัวเลขและ boolean เป็นประเภทดั้งเดิม ให้สลับ Using Fields Below ถึง Using JSON และวาง object JSON ของคุณที่มี parameter

1. จาก node คำขอ HTTP Parameters แท็บ ให้เลือก นำเข้า cURL (Import cURL) . ที่ นำเข้าคำสั่ง cURL (Import cURL command) กิริยาจะเปิดขึ้น
2. วางคำสั่ง curl ลงในกล่องข้อความ
3. เลือก Import . n8n โหลดการกำหนดค่าคำขอลงในฟิลด์ node สิ่งนี้จะเขียนทับการกำหนดค่าที่มีอยู่

เทมเพลตและตัวอย่าง

เรียกดูเทมเพลตการรวมคำขอ HTTP หรือ ค้นหาเทมเพลตทั้งหมด

คำถามที่พบบ่อย

ฉันจะเรียก API โดยไม่ต้องเขียนโค้ดได้อย่างไร (How do I call an API without writing code?)

ใช้ node คำขอ HTTP เพื่อสืบค้นข้อมูลจากแอปหรือบริการใดๆ ด้วย REST API ตั้งค่า parameter node (เมธอด, URL, parameter การสืบค้น, ส่วนหัว และเนื้อหา) หรือ นำเข้าคำสั่ง curl จากเอกสาร API ของบริการและ n8n จะกรอกข้อมูลในช่องให้คุณ

ฉันจะตรวจสอบคำขอ API ได้อย่างไร (How do I authenticate an API request?)

ตั้งค่านี้ใน การรับรองความถูกต้อง ส่วน ใช้ Predefined Credential Type เมื่อ n8n รองรับบริการนี้ เนื่องจากเป็นวิธีการตั้งค่าที่ง่ายที่สุด สำหรับ API อื่นๆ ให้ใช้ credentials ทั่วไปซึ่งรองรับการตรวจสอบสิทธิ์ขั้นพื้นฐาน, การตรวจสอบสิทธิ์ส่วนหัว, OAuth1, OAuth2 และอื่นๆ อ้างถึง HTTP Request credentials.

ฉันจะจัดการ API ที่ส่งคืนผลลัพธ์ในหลาย ๆ หน้าได้อย่างไร (How do I handle an API that returns results across many pages?)

เปิดเครื่อง pagination ตัวเลือก ตั้ง ก Pagination Mode เพื่ออัปเดต parameter ในแต่ละคำขอ หรือติดตาม URL หน้าถัดไปในการตอบกลับ ดังนั้น n8n จึงดึงข้อมูลทุกหน้าแทนที่จะเป็นเพียงหน้าแรก

ปัญหาทั่วไป

สำหรับคำถามหรือปัญหาทั่วไปและวิธีแก้ปัญหาที่แนะนำ โปรดดูที่ Common Issues.