Ugrás a dokumentációra
API

Fordítás előnézete

Mit állítana elő a `translate` egy küldésnél, úgy, hogy semmi nem kerül elküldésre és tárolásra.

POSTapi.openemail.uk/emails/translate

A valódi hívást futtatja le a munkaterületén, a saját kulcsával.

POST /emails/translate

Mit állítana elő a translate egy küldésnél, úgy, hogy semmi nem kerül elküldésre és tárolásra.

A kérés

Ugyanaz a három opció, amelyet egy küldés feldolgoz, a boríték nélkül, ugyanazon a függvényen átfuttatva, amelyet a küldési útvonal is hív. Ez az azonosság adja a végpont teljes értékét: egy saját kóddal rendelkező előnézet olyan ígéret lenne, amelyet nem tartunk be, és azon a napon, amikor a kettő elválik egymástól, a valakinek a képernyőjén látható és a címzett postafiókjába érkező tartalom eltérne, anélkül hogy bármi jelezné.

Paraméterek

tostringkötelező
A nyelv, amelyen írni kell. BCP-47 kód (`de`), angol név ("German") vagy a nyelv saját neve ("Deutsch"). A válasz megadja, melyik kódra oldódott fel, és ezt a formát érdemes tárolni, ha kapcsolatonként nyilvántartasz egy nyelvet.
htmlstring
A HTML törzs, legfeljebb egy megabájt. A html, text és subject közül egy kötelező.
textstring
A sima szöveges rész. A `html`-től függetlenül fordítódik, saját hosszellenőrzéssel.
subjectstring
A tárgy SORA: string, nem az a boolean, ami egy küldés `translate` mezőjében. A kettő különböző kérdés: ott azt mondod meg, hogy lefordítsuk-e a nálunk már meglévő tárgyat, itt pedig átadsz egyet.
fromstring
Amilyen nyelven írtad, ugyanazon három forma bármelyikében. Ha megadod, a nyelvfelismerő hívás kimarad.
includeOriginalboolean
Tartalmazza-e a visszaadott `html` már az eredetit a fordítás alatt. Alapértelmezés: true.

Az ismeretlen kulcsok 422-t adnak, mint mindenhol máshol. Az a kérés, amely a html, text és subject egyikét sem tartalmazza, 422 a html mezőn: "One of html, text or subject is required".

Előnézet

Az oda-vissza út, amelyet a szerkesztő megtesz, mielőtt megmutatja valakinek, mit készül elküldeni.

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"  }'
Válasz
{  "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}

A html, text és subject null értékkel tér vissza, nem hiányzik, ha az adott mezőt nem küldted, így a kliens meg tudja jeleníteni a választ anélkül, hogy emlékeznie kellene, mit kérdezett.

A detectedSourceLanguage null, ha a felismerés nem döntött. Ez valódi válasz, nem hiba. A nevekből, számokból és linkekből álló törzs nem ad mit olvasni, és ennek egyetlen következménye, hogy az eredeti nyelvmegjelölés nélkül kap feliratot.

Az includeOriginal visszatér a válaszban, mert megváltoztatja, mit tartalmaz a html. Bekapcsolt állapotban a törzs már tartalmazza az eredetit a fordítás alatt, és ha saját másolatot is hozzáfűzöl, kétszer lesz elküldve.

Előnézet, szerkesztés, küldés

Erre a folyamatra készült: előnézet, SZERKESZTÉS, küldés. Mutasd meg a fordítást, hagyd, hogy módosítsák, majd küldd el, amit jóváhagytak, szokásos html-ként és subject-ként, translate nélkül a kérésben. Így ami elmegy, az szóról szóra az, amit jóváhagytak.

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>"  }'

Ha előnézet után translate-tel küldesz, az másodszor is lefordít, és elveti a szerkesztéseket. A küldemény olyan megfogalmazásban menne ki, amelyet senki nem olvasott, és pontosan ez az a hiba, amelynek megelőzésére az előnézet létezik.

Mibe kerül, és mit nem csinál

  • Három modellhívás (a törzs, a tárgy, és egy a forrásnyelv megállapítására) egyszerre indul, így a várakozás a leghosszabb hívás ideje, nem a három összege. A from megadásával a harmadik elmarad. Ugyanannyiba kerül, mint egy translate-tel történő küldés, ezért egyszer kérj előnézetet, ne minden módosításnál.
  • Semmi nem kerül elküldésre, nem íródik sor, és nem jön vissza azonosító. Nincs mit később visszavonni vagy lekérni.
  • Fordít, és semmi mást nem csinál. Nem lektorál, nem javítja a szöveget, és soha nem válaszol az üzenetre.
  • A nevek, cégek, linkek, rendelésszámok, árak és dátumok úgy térnek vissza, ahogy bementek, így a fordítás soronként összevethető az eredetivel.
  • Az idézett előzmények nem kerülnek eltávolításra, szemben az olvasási oldallal. Amit átadsz, az fordítódik le, ami egy szerkesztőnél helyes, ahol a törzs csak az, amit valaki éppen megírt, de érdemes tudni, ha egy teljes válaszláncot küldesz be.
  • emails:send hatókörrel, saját hatókör nélkül: semmi olyat nem enged, amit egy küldő eddig is ne tehetne meg, és egy olyan hatókör, amelyet senki nem tud megkülönböztetni az emails:send-től egy hozzájárulási képernyőn, a lista minden más hatókörét kicsit kevesebbet jelentővé teszi.

A törzs ugyanarra az egy megabájtra van korlátozva, mint egy küldésnél, de maga a fordítás minden 30 000 karakternél hosszabb szöveget elutasít translation_too_long kóddal. A hibakódok ugyanazok, mint amelyeket egy fordított küldés ad vissza, az E-mail küldése alatt felsorolva.