Bỏ qua tới phần tài liệu
API

Xem trước bản dịch

Kết quả mà `translate` sẽ tạo ra trên một lần gửi, mà không gửi hay lưu gì cả.

POSTapi.openemail.uk/emails/translate

Chạy lệnh gọi thật với không gian làm việc của bạn, bằng khóa của chính bạn.

POST /emails/translate

Kết quả mà translate sẽ tạo ra trên một lần gửi, mà không gửi hay lưu gì cả.

Yêu cầu

Cùng ba tùy chọn mà một lần gửi xử lý, trừ phần phong bì thư, được chạy qua cùng hàm mà luồng gửi gọi. Sự đồng nhất đó là toàn bộ giá trị của endpoint này: một bản xem trước có mã riêng sẽ là lời hứa mà chúng tôi không giữ được, và vào ngày hai bên lệch nhau, thứ hiển thị trên màn hình của ai đó và thứ nằm trong hộp thư đến của người nhận sẽ khác nhau mà không có gì báo hiệu.

Tham số

tostringbắt buộc
Ngôn ngữ cần viết. Một mã BCP-47 (`de`), tên tiếng Anh ("German") hoặc tên của ngôn ngữ đó bằng chính ngôn ngữ ấy ("Deutsch"). Phản hồi cho bạn biết mã đã được phân giải thành gì, và đó là dạng nên lưu nếu bạn lưu ngôn ngữ cho từng liên hệ.
htmlstring
Nội dung HTML, tối đa một megabyte. Bắt buộc có một trong html, text hoặc subject.
textstring
Phần văn bản thuần. Được dịch độc lập với `html`, với giới hạn độ dài riêng.
subjectstring
DÒNG tiêu đề: một string, không phải giá trị boolean như khi nằm trong `translate` trên một lần gửi. Đây là hai câu hỏi khác nhau: ở đó bạn cho biết có dịch tiêu đề mà chúng tôi đã có hay không, còn ở đây bạn đang đưa tiêu đề cho chúng tôi.
fromstring
Ngôn ngữ bạn đã dùng để viết, theo bất kỳ dạng nào trong ba dạng trên. Khai báo nó sẽ bỏ qua lệnh gọi nhận diện ngôn ngữ.
includeOriginalboolean
Cho biết `html` trả về có chứa sẵn bản gốc của bạn bên dưới bản dịch hay không. Mặc định là true.

Key không xác định trả về 422, như ở mọi nơi khác. Yêu cầu không có html, text hay subject sẽ trả về 422 trên html: "One of html, text or subject is required".

Xem trước

Quy trình khứ hồi mà trình soạn thư thực hiện trước khi cho ai đó xem những gì họ sắp gửi.

curl
curl -X POST "$OE/emails/translate" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "subject": "Your September invoice",    "html": "<p>Invoice attached. Payment is due on the 14th.</p>",    "to": "de"  }'
Phản hồi
{  "object": "translation",  "language": { "code": "de", "label": "German", "native": "Deutsch", "flag": "🇩🇪", "rtl": false },  "detectedSourceLanguage": {    "code": "en", "label": "English", "native": "English", "flag": "🇬🇧", "rtl": false  },  "subject": "Ihre Rechnung für September",  "html": "<p>Rechnung im Anhang. Zahlbar bis zum 14.</p>\n<div style=\"margin:28px 0 0;padding:14px 0 0;border-top:1px solid #d6dae0\">\n<div style=\"margin:0 0 10px;font-size:12px;line-height:1.5;color:#6b7280\">Ursprüngliche Nachricht (English)</div>\n<div><p>Invoice attached. Payment is due on the 14th.</p></div>\n</div>",  "text": null,  "includeOriginal": true}

html, textsubject được trả về là null thay vì vắng mặt đối với trường bạn không gửi, nên client có thể hiển thị kết quả mà không cần nhớ mình đã yêu cầu gì.

detectedSourceLanguage là null khi việc nhận diện bỏ qua. Đó là một câu trả lời thực sự chứ không phải lỗi. Nội dung toàn tên, con số và liên kết không có gì để đọc, và hệ quả duy nhất là bản gốc của bạn được chú thích mà không có tên ngôn ngữ.

includeOriginal được trả lại vì nó thay đổi nội dung của html. Khi bật, nội dung đã chứa sẵn bản gốc của bạn bên dưới bản dịch, và nếu bạn tự nối thêm bản sao của mình thì nó sẽ bị gửi hai lần.

Xem trước, chỉnh sửa, gửi

Quy trình mà endpoint này được xây dựng cho là xem trước, CHỈNH SỬA, gửi: cho một người xem bản dịch, để họ sửa, rồi gửi nội dung họ đã duyệt dưới dạng htmlsubject thông thường, hoàn toàn không có translate trong yêu cầu. Khi đó, những gì họ đã duyệt chính là từng chữ được gửi đi.

curl
curl -X POST "$OE/emails" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "from": "[email protected]",    "to": ["[email protected]"],    "subject": "Ihre Rechnung für September",    "html": "<p>Rechnung im Anhang. Zahlbar bis zum 14.</p>"  }'

Gửi với translate sau khi xem trước sẽ dịch lần thứ hai và bỏ đi các chỉnh sửa. Thư sẽ được gửi đi với câu chữ chưa ai đọc, đó chính là lỗi mà bản xem trước tồn tại để ngăn chặn.

Chi phí, và những gì nó không làm

  • Ba lệnh gọi mô hình (phần nội dung, tiêu đề, và một lệnh để xác định ngôn ngữ bạn đã viết) được thực hiện đồng thời, nên thời gian chờ bằng lệnh lâu nhất trong ba chứ không phải tổng của chúng. Khai báo from sẽ bỏ lệnh thứ ba. Chi phí giống như khi gửi với translate, vì vậy hãy xem trước một lần thay vì mỗi lần chỉnh sửa.
  • Không có gì được gửi, không có hàng nào được ghi và không có id nào được trả về. Không có gì ở đây để hủy hay lấy lại sau này.
  • Nó chỉ dịch và không làm gì khác. Nó không soát lỗi, không trau chuốt câu văn và không bao giờ trả lời thư.
  • Tên người, tên công ty, liên kết, mã đơn hàng, giá và ngày tháng được giữ nguyên như đầu vào, nên có thể đối chiếu bản dịch với bản gốc từng dòng một.
  • Lịch sử được trích dẫn không bị loại bỏ, khác với phần đọc thư. Những gì bạn đưa vào là những gì được dịch, điều này phù hợp với trình soạn thư, nơi nội dung chỉ là những gì ai đó vừa viết, và đáng lưu ý nếu bạn gửi lên cả một chuỗi thư trả lời.
  • Dùng phạm vi emails:send, không có phạm vi riêng: nó không cấp thêm quyền nào mà người gửi chưa có, và một phạm vi không ai phân biệt được với emails:send trên màn hình cấp quyền sẽ khiến mọi phạm vi khác trong danh sách đó bớt ý nghĩa đi một chút.

Phần thân bị giới hạn ở cùng một megabyte như khi gửi, nhưng bản thân việc dịch sẽ từ chối mọi nội dung vượt quá 30.000 ký tự với translation_too_long. Các mã lỗi giống với mã mà một lần gửi có dịch trả về, được liệt kê trong mục Gửi email.