Tạo API key n8n: quản lý workflow qua public API
Hướng dẫn tạo khóa n8n, chọn quyền và thời hạn, gọi thử public API, rồi lưu khóa vào credential để dùng trong workflow.

API key n8n cho phép một ứng dụng bên ngoài làm việc với public API của instance n8n. Bạn có thể lấy danh sách workflow, đọc execution hoặc thực hiện thao tác quản lý được tài khoản cho phép. Khóa được tạo trong Settings → n8n API và gửi qua header X-N8N-API-KEY; hãy sao chép ngay khi tạo vì giao diện không hiển thị lại toàn bộ khóa.
Cần phân biệt hai chiều kết nối: bài này nói về ứng dụng gọi vào n8n. Nếu workflow cần gọi dịch vụ bên ngoài, hãy đọc thêm API vào n8n bằng HTTP Request. Còn bảo mật credentials và API key giải thích cách giữ khóa khi vận hành lâu dài.
API n8n là gì?
Public API là giao diện lập trình để phần mềm trao đổi với n8n mà không phải bấm từng nút trên màn hình. Tùy endpoint và quyền tài khoản, bạn có thể quản lý workflow, credential, tag hay dữ liệu các lần thực thi. Vì API có thể thay đổi tài nguyên thật, khóa quản trị cần được bảo vệ cẩn thận.
Vai trò và chức năng của API n8n
- Điều khiển workflow: đọc danh sách, tạo mới, chỉnh sửa và thực hiện thao tác triển khai mà phiên bản API hỗ trợ.
- Làm việc với credential: tạo hoặc xóa thông tin xác thực theo endpoint và quyền được cấp.
- Lấy dữ liệu vận hành: truy vấn executions và các tài nguyên để lập báo cáo.
- Tích hợp công cụ nội bộ: đưa thao tác n8n vào ứng dụng quản trị hoặc quy trình CI/CD.
Khi nào cần tạo API key n8n?
- Tự động hóa quản trị: script cần đọc trạng thái hoặc thao tác trên n8n.
- Ứng dụng riêng: phần mềm tạo workflow theo yêu cầu hoặc theo dõi tiến trình thực thi.
- Sao lưu và khôi phục: tự động lấy cấu hình workflow bằng endpoint phù hợp; đừng giả định API cho phép đọc lại bí mật của credential.
- CI/CD: cập nhật workflow cùng đợt phát hành phần mềm.
- Giám sát: chuyển số liệu lần chạy và lỗi sang hệ thống báo cáo.
Nếu mục tiêu chỉ là kích hoạt một workflow từ bên ngoài, Webhook thường phù hợp hơn việc cấp khóa quản lý public API. Chỉ tạo API key khi thực sự cần thao tác với tài nguyên của n8n.
Điều kiện sử dụng: kiểm tra public API có được bật cho gói và instance của bạn hay không. Tài liệu API authentication nêu API không khả dụng trong thời gian dùng thử miễn phí của n8n Cloud.
Cách tạo API key trong n8n
Bước 1: Mở Settings
Mở menu tài khoản ở phía dưới bên trái, sau đó vào Settings. Vị trí có thể thay đổi nhẹ theo phiên bản giao diện.

Bước 2: Chọn n8n API
Chọn n8n API trong Settings để xem các khóa đang tồn tại. Muốn thêm khóa, bấm Create an API key.

Bước 3: Điền thông tin API key
- Label: dùng tên mô tả tác vụ, chẳng hạn “Báo cáo workflow”, để nhận biết khi thu hồi.
- Expiration: chọn thời gian sử dụng đủ cho tác vụ; hạn ngắn giúp giảm thời gian một khóa bị lộ còn hoạt động.
- Scopes: từ n8n 2.14.0, mọi gói đều có thể giới hạn quyền API key. Với phiên bản cũ hơn, tính năng này yêu cầu Enterprise; khóa non-Enterprise trên bản cũ có quyền rộng theo tài khoản. Chỉ cấp quyền tối thiểu, ví dụ đọc workflow cho script báo cáo.

Bấm Save, sao chép khóa vừa sinh và lưu trong trình quản lý bí mật. Nếu đã đóng cửa sổ trước khi lưu, hãy tạo khóa khác thay vì tìm cách xem lại khóa cũ.

Chỉ bấm Done sau khi đã lưu khóa an toàn.
Bước 4: Gọi thử n8n API
Dùng địa chỉ instance của bạn cộng với /api/v1 làm base URL. Với bản Cloud, địa chỉ thường nằm dưới tên miền app.n8n.cloud; bản tự host dùng domain riêng. Request sau gửi khóa trong header để đọc danh sách workflow:
curl -X GET "https://n8n.example.com/api/v1/workflows" \
-H "accept: application/json" \
-H "X-N8N-API-KEY: <API key của bạn>"Phản hồi JSON chứa danh sách workflow cho thấy request đã được xác thực và endpoint hoạt động. Nếu nhận 401, kiểm tra khóa có đúng, còn hạn và chưa bị xóa; nếu thiếu quyền, kiểm tra scopes và vai trò tài khoản.
Cách tạo credential n8n API với API key
Khi một workflow cần gọi public API của n8n, bạn có thể lưu khóa bằng credential loại n8n API rồi dùng trong node n8n. Cách này tránh lặp lại khóa ở từng node.
Bước 1: Mở hộp thoại tạo credential
Mở Create → Credential. Trên các bản giao diện cũ, lựa chọn này nằm trong menu bên cạnh Create Workflow.

Ảnh minh họa dùng giao diện n8n cũ nên có thể còn công tắc Inactive. Với bản mới, hãy tìm thao tác tạo credential và chức năng Publish tương ứng, thay vì bám vào vị trí nút trong ảnh.
Bước 2: Chọn n8n API
Trong Add new credential, tìm “n8n API”, chọn kết quả đúng rồi nhấn Continue.

Bước 3: Điền thông tin credential
- Tên: đặt tên dễ phân biệt, ví dụ “n8n API – báo cáo”.
- API Key: nhập khóa đã lưu ở bước tạo key.
- Base URL: nhập địa chỉ API của instance, ví dụ https://n8n.example.com/api/v1.

Lưu credential bằng Save, sau đó chọn nó trong node n8n. Node chỉ thực hiện được các thao tác mà khóa, scopes và tài khoản cho phép.
Những lưu ý khi tạo API key n8n
- Tách mục đích: mỗi ứng dụng hoặc tác vụ dùng một key để có thể thu hồi độc lập.
- Có ngày hết hạn: ưu tiên hạn vừa đủ dùng; lên lịch thay khóa trước khi hết hạn.
- Giới hạn scopes: trên bản có hỗ trợ, bỏ các quyền ghi nếu chỉ cần đọc. Với bản cũ không có scopes, cân nhắc nâng cấp trước khi cấp khóa rộng.
- Giữ kín: không đặt khóa trong code, chat hay ảnh chụp; cũng không ghi khóa vào execution log.
- Rà soát định kỳ: xóa các khóa đã bỏ dùng và thay ngay khóa nghi bị lộ.
Kết luận
Phần thao tác quan trọng nằm ở Settings → n8n API, nhưng quyền của khóa mới là yếu tố quyết định rủi ro. Hãy xác định tác vụ, chọn scopes theo phiên bản đang chạy, thử một request chỉ đọc rồi mới tích hợp vào quy trình thật.
Những câu hỏi thường gặp
Có thể tạo bao nhiêu API key?
Tài liệu không công bố một mức trần chung cho số key. Hãy tạo theo từng ứng dụng hoặc mục đích, thay vì dùng một khóa cho mọi nơi.
Có thay đổi scopes của API key đã tạo được không?
Khả năng chỉnh sửa phụ thuộc phiên bản. Cách thay quyền an toàn là tạo key mới với scopes cần thiết, kiểm tra ứng dụng hoạt động, chuyển cấu hình sang key mới rồi thu hồi key cũ. Scopes có trên mọi gói từ 2.14.0; bản trước đó cần Enterprise.
Làm thế nào để thu hồi một API key?
Trong Settings → n8n API, tìm đúng Label rồi chọn Delete và xác nhận. Các lần gọi tiếp theo bằng khóa đó sẽ không xác thực được.
Điều gì xảy ra khi API key hết hạn?
Sau thời hạn đã đặt, khóa không còn dùng để xác thực request. Bạn cần tạo khóa mới và cập nhật ứng dụng hoặc credential đang tham chiếu khóa cũ.
API key n8n khác credential thế nào?
API key n8n cho phép phần mềm gọi vào n8n. Credential là bản ghi n8n dùng để lưu thông tin xác thực khi gọi một dịch vụ; credential n8n API cũng có thể chứa chính API key n8n để node n8n sử dụng.