API

Bắt đầu nhanh

Một khóa và lần gửi đầu tiên.

1. Tạo khóa

Mở Cài đặt → Khóa API. Trang này chỉ xuất hiện nếu bạn sở hữu hộp thư.
Đặt tên theo thứ sẽ sử dụng nó. Tên đó là cách bạn tìm lại khóa khi cần thu hồi.
Chọn phạm vi. Mặc định chỉ có quyền gửi.
Tùy chọn thu hẹp những gì khóa có thể gửi với tư cách: toàn bộ tên miền, từng địa chỉ, hoặc cả hai. Một tên miền trọn vẹn bao gồm cả các địa chỉ được thêm vào sau này.
Sao chép khóa. Khóa chỉ hiển thị một lần và không thể khôi phục: thứ được lưu là một hàm băm một chiều. Xoay vòng khóa sau này cũng hiển thị khóa thay thế một lần theo cùng cách.

2. Gửi thứ gì đó

npm install @openemail/sdk

Tùy chọn. Mọi endpoint đều là HTTP và JSON thuần, và tab curl bên dưới không cần cài đặt gì cả.

curl -X POST https://api.openemail.uk/emails \  -H "Authorization: Bearer $OPENEMAIL_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "from": "Acme Billing <[email protected]>",    "to": ["[email protected]"],    "subject": "Your September invoice",    "html": "<p>Invoice attached.</p>"  }'

Mã 200 nghĩa là thư đã đi. Bạn nhận lại một id. Hãy giữ nó: đó là cách bạn truy xuất thư, đọc chuỗi sự kiện của nó, hoặc hủy nó nếu bạn đã lên lịch.

Nhận lỗi 403 ngoài dự kiến? GET /addresses liệt kê chính xác những gì khóa này có thể gửi với tư cách. Nguyên nhân gần như luôn là phạm vi gửi trên khóa, hoặc một tên miền hay địa chỉ mà khóa không được cấp, chứ không phải tên miền bị thiếu trên không gian làm việc.