Tích hợp API với N8N: Hướng dẫn từng bước

Integrating APIs with n8n: A Step-by-Step Tutorial

Tích hợp API với N8N: Hướng dẫn từng bước

Tích hợp API với N8N cung cấp một cách được sắp xếp hợp lý để tự động hóa quy trình công việc giữa các dịch vụ khác nhau. N8N (phát âm là “N-Eight-N”) là một công cụ tự động hóa quy trình công việc nguồn mở cho phép bạn kết nối các API, cơ sở dữ liệu khác nhau và hơn thế nữa, tất cả mà không cần kiến ​​thức mã hóa rộng rãi. Hướng dẫn này sẽ hướng dẫn bạn tích hợp API vào quy trình công việc N8N của bạn với các hướng dẫn từng bước để giúp bạn tạo tự động hóa hiệu quả.

Điều kiện tiên quyết

Trước khi bắt đầu, đảm bảo bạn có những điều sau:

  1. N8N đã cài đặt: Bạn có thể sử dụng N8N thông qua Docker hoặc trực tiếp trên máy cục bộ của bạn. Để cài đặt N8N qua Docker, bạn có thể chạy:

    docker run -it --rm 
      -p 5678:5678 
      n8nio/n8n

    Truy cập phiên bản N8N của bạn thông qua https://localhost:5678.

  2. Tài liệu API: Lấy tài liệu API cho dịch vụ bạn muốn tích hợp. Điều này nên bao gồm các điểm cuối, tham số yêu cầu và chi tiết xác thực.

  3. Khóa API hoặc mã thông báo truy cập: Nhiều API yêu cầu xác thực. Đảm bảo bạn có thông tin cần thiết để xác thực các yêu cầu API của bạn.

Bước 1: Tạo quy trình làm việc mới

  1. Mở phiên bản N8N của bạn và nhấp vào “quy trình công việc” từ menu điều hướng.

  2. Nhấp vào Mới Nút để tạo một quy trình làm việc mới.

  3. Đặt cho quy trình công việc của bạn một cái tên có ý nghĩa để nhận dạng dễ dàng hơn sau này.

Bước 2: Thêm nút API

  1. Từ bảng điều khiển bên trái, nhấp vào Nút Để thêm một nút mới vào quy trình làm việc của bạn.

  2. Tìm kiếm nút yêu cầu HTTP, vì nút này cho phép bạn thực hiện các cuộc gọi API. Nhấp vào Yêu cầu HTTP nút để thêm nó vào quy trình làm việc của bạn.

  3. Sau khi thêm nút yêu cầu HTTP, bạn sẽ tùy chỉnh nó để phù hợp với API mà bạn đang tích hợp.

Bước 3: Định cấu hình nút yêu cầu HTTP

  1. Đặt phương thức: Trong cài đặt nút yêu cầu HTTP, chọn phương thức HTTP thích hợp (GET, POST, PUT, XÓA) Dựa trên điểm cuối API mà bạn sẽ sử dụng.

  2. Đặt URL: Nhập URL điểm cuối API. Tham khảo tài liệu API cho URL điểm cuối thích hợp.

  3. Thêm tiêu đề hoặc tham số:

    • Đối với API yêu cầu xác thực, hãy thêm tiêu đề ủy quyền:
      • Chìa khóa: Authorization
      • Giá trị: Người mang your_access_token
    • Nếu API yêu cầu các tiêu đề bổ sung, chẳng hạn như Content-Typethêm những người đó là:
      • Chìa khóa: Content-Type
      • Giá trị: application/json (hoặc bất kỳ định dạng nào được yêu cầu)
    • Để thêm tham số hoặc nội dung cơ thể, hãy sử dụng Query Parameters tab hoặc Body Parameters Tab tùy thuộc vào nhu cầu của API.
  4. Đặt định dạng phản hồi: Chọn cách bạn muốn N8N xử lý phản hồi API. Đối với các phản hồi của JSON, bạn thường sẽ chọn JSON.

Bước 4: Kiểm tra nút của bạn

  1. Sau khi định cấu hình nút, nhấp vào Thực thi nút Nằm ở phía trên bên phải của cài đặt nút yêu cầu HTTP.

  2. Xem đầu ra trong phần Kết quả thực thi để xác minh rằng cuộc gọi API đã thành công và trả về phản hồi dự kiến. Nếu có lỗi, hãy khắc phục sự cố dựa trên thông báo lỗi được hiển thị.

Bước 5: Thêm nhiều nút

  1. Tùy thuộc vào những gì bạn muốn hoàn thành, bạn có thể cần thêm nhiều nút vào quy trình làm việc của mình. Ví dụ: nếu bạn muốn gửi email sau khi tìm nạp dữ liệu từ API, bạn có thể thêm một nút email.

  2. Nhấp vào Nút Tab một lần nữa và tìm kiếm nút email, sau đó thêm nó vào quy trình làm việc của bạn.

  3. Kết nối nút yêu cầu HTTP với nút email bằng cách nhấp vào vòng tròn nhỏ ở phía bên phải của nút yêu cầu HTTP và kéo nó sang phía bên trái của nút email.

Bước 6: Định cấu hình nút email

  1. Trong cài đặt nút email, định cấu hình địa chỉ email, chủ đề và nội dung cơ thể của người nhận.

  2. Bạn có thể sử dụng dữ liệu thu được từ nút yêu cầu HTTP trước đó trong thân email của bạn. Sử dụng các biểu thức để dữ liệu tham chiếu, chẳng hạn như {{$json["responseKey"]}}Ở đâu responseKey Đề cập đến khóa JSON từ phản hồi HTTP.

Bước 7: Thực hiện quy trình công việc hoàn chỉnh

  1. Khi tất cả các nút được cấu hình, nhấp vào Thực hiện quy trình làm việc nút ở đầu trình chỉnh sửa quy trình làm việc.

  2. Giám sát việc thực hiện từng bước của quy trình làm việc trong bảng điều khiển bên trái để đảm bảo rằng nó chạy thành công.

  3. Nếu bạn gặp bất kỳ vấn đề nào, hãy xem lại cài đặt nút, kiểm tra kỹ các tham số API của bạn và tham khảo tài liệu API để làm rõ.

Bước 8: Lên lịch quy trình làm việc của bạn

Nếu tích hợp của bạn cần chạy định kỳ (ví dụ: tìm nạp dữ liệu mỗi giờ), bạn có thể lên lịch:

  1. Thêm a Cron nút cho quy trình làm việc của bạn. Định cấu hình cài đặt cron cho lịch trình mong muốn.

  2. Kết nối nút Cron với nút Yêu cầu HTTP của bạn để tự động hóa cuộc gọi API dựa trên lịch trình đã xác định.

  3. Thực hiện quy trình làm việc để đảm bảo nó chạy trơn tru theo lịch trình cron.

Bước 9: Xử lý lỗi

Để làm cho quy trình làm việc của bạn mạnh mẽ, hãy xem xét việc thực hiện xử lý lỗi:

  1. Sử dụng NẾU NHƯ nút để kiểm tra các phản hồi API thành công. Kết nối nó với nút yêu cầu HTTP và xác định một điều kiện dựa trên mã trạng thái phản hồi (ví dụ: {{$json["statusCode"]}} === 200).

  2. Nếu cuộc gọi API không thành công, bạn có thể định tuyến quy trình công việc để gửi thông báo lỗi qua email hoặc đăng nhập lỗi.

  3. Định cấu hình Quy trình công việc lỗi Cài đặt trong N8N để xử lý các lỗi bất ngờ một cách duyên dáng.

Bước 10: Lưu và xuất quy trình làm việc của bạn

  1. Nhấp vào Cứu nút ở góc trên bên phải để lưu quy trình làm việc của bạn.

  2. Nếu bạn muốn chia sẻ hoặc nhập quy trình làm việc của mình ở nơi khác, hãy nhấp vào Xuất khẩu Tùy chọn và tải xuống tệp JSON. Điều này có thể được chia sẻ với những người khác hoặc được nhập vào một trường hợp N8N khác.

Thực tiễn tốt nhất để tích hợp API với N8N

  1. Đánh giá tài liệu: Luôn tham khảo tài liệu API chính thức để hiểu giới hạn tỷ lệ và định dạng yêu cầu cho phép.

  2. Ghi nhật ký lỗi: Sử dụng các nút ghi nhật ký để theo dõi lỗi và gỡ lỗi quy trình công việc một cách hiệu quả.

  3. Sử dụng các biến môi trường: Đối với thông tin nhạy cảm như khóa API, hãy xem xét sử dụng các biến môi trường trong N8N để duy trì bảo mật.

  4. Kiểm soát phiên bản: Giữ cho quy trình công việc của bạn được phiên bản, đặc biệt đối với các tự động tự động quan trọng có thể ảnh hưởng đến các quy trình kinh doanh.

  5. Giám sát hiệu suất: Sau khi triển khai quy trình công việc trong môi trường sản xuất, hãy theo dõi hiệu suất của họ thường xuyên để đảm bảo chúng hoạt động như mong đợi.

Bằng cách làm theo hướng dẫn toàn diện này, bạn có thể tích hợp API một cách hiệu quả với N8N và tự động hóa các tác vụ khác nhau một cách liền mạch. Khám phá các nút khác nhau, thử nghiệm các quy trình công việc phức tạp hơn và tận dụng sức mạnh của tự động hóa để tăng cường năng suất.