Tích hợp Notex bằng API Key

API Key cho phép ứng dụng, script hoặc hệ thống của bạn gọi Notex API mà không cần đăng nhập thủ công trong mỗi request.

Bạn có thể sử dụng API Key để tự động tạo ghi chú, xử lý tài liệu và tạo các nội dung như flashcard, quiz, mindmap, slide hoặc podcast.

Khi nào nên sử dụng API Key?

API Key phù hợp với các tác vụ chạy trên backend hoặc server của bạn.

Một số ví dụ:

• Tự động tạo ghi chú khi có tài liệu mới.
• Tích hợp tính năng tóm tắt tài liệu vào ứng dụng khác.
• Gửi URL hoặc tệp từ hệ thống nội bộ sang Notex.
• Tự động tạo flashcard, quiz hoặc slide từ ghi chú.
• Kết nối Notex với workflow và công cụ automation.

API Key hoạt động với quyền của tài khoản đã tạo ra nó. Dữ liệu được tạo và Credits được sử dụng sẽ được tính cho tài khoản đó.

Lấy API Key

Để tạo API Key:

1. Đăng nhập vào tài khoản Notex.
2. Mở trang Settings.
3. Chọn API Keys.
4. Chọn Create API Key.
5. Đặt tên cho key và chọn thời gian hết hạn nếu cần.
6. Sao chép API Key và lưu lại ngay.

API Key của Notex có dạng:

ntx_live_xxxxxxxxxxxxxxxxxxxx

Giá trị đầy đủ của API Key chỉ được hiển thị một lần tại thời điểm tạo. Bạn sẽ không thể xem lại key sau khi đóng cửa sổ này.

Lưu API Key an toàn

Hãy lưu API Key trong secret manager hoặc biến môi trường trên server.

NOTEX_API_KEY=ntx_live_xxxxxxxxxxxxxxxxxxxx

Không nên:

• Đặt API Key trong mã nguồn frontend.
• Commit API Key lên Git.
• Gửi API Key qua email hoặc tin nhắn.
• Ghi giá trị đầy đủ của API Key vào log.
• Chia sẻ một API Key cho nhiều hệ thống không liên quan.

Nên tạo API Key riêng cho từng ứng dụng và từng môi trường như development, staging và production.

Nếu API Key bị lộ, hãy thu hồi key đó ngay trong trang API Keys và tạo một key mới.

Gửi request đầu tiên

Base URL của Notex API:

https://api.notexapp.com

Gửi API Key thông qua header X-API-Key:

curl https://api.notexapp.com/<endpoint> \
  -H "X-API-Key: $NOTEX_API_KEY"

Bạn cũng có thể sử dụng Bearer Authentication:

curl https://api.notexapp.com/<endpoint> \
  -H "Authorization: Bearer $NOTEX_API_KEY"

Chỉ cần sử dụng một trong hai phương thức xác thực.

Ví dụ cơ bản

Ví dụ sau gửi một request tạo ghi chú từ URL:

curl -X POST https://api.notexapp.com/<create-note-endpoint> \
  -H "X-API-Key: $NOTEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/article"
  }'

Một số tác vụ có thể không trả về kết quả hoàn chỉnh ngay lập tức.

Trong trường hợp đó, API sẽ trả về một task_id. Bạn có thể sử dụng Tasks API để kiểm tra trạng thái xử lý và lấy kết quả sau khi tác vụ hoàn tất.

Gửi request
    ↓
Nhận task_id
    ↓
Kiểm tra trạng thái task
    ↓
Nhận kết quả

Các tính năng hỗ trợ API Key

Lưu ý

• API Key sử dụng quyền của tài khoản đã tạo ra nó.
• Mọi giới hạn về gói dịch vụ và Credits vẫn được áp dụng.
• Một số tính năng yêu cầu Credits để xử lý.
• Chỉ nên gọi Notex API từ backend hoặc server được kiểm soát.
• Thu hồi các API Key không còn sử dụng.
• Không sử dụng API Key trong ứng dụng frontend hoặc mã nguồn công khai.

Bước tiếp theo

Bắt đầu bằng cách tạo API Key, lưu key vào biến môi trường và thử một request đơn giản với Notes API.