API

Sūtīt ar veidni

Saglabātais saturs dod ziņojumu; pieprasījums dod aploksni un vērtības.

POSTapi.openemail.uk/templates/{id}/send

Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.

POST /templates/{id}/send

Saglabātais saturs dod ziņojumu; pieprasījums dod aploksni un vērtības.

Piemērs

Nepieciešams templates:write UN emails:send. Ievēro Idempotency-Key tieši tāpat kā POST /emails.

curl

curl -X POST "$OE/templates/order-shipped/send" -H "$AUTH" \  -H "Content-Type: application/json" -H "Idempotency-Key: order:AC-4192:shipped" \  -d '{    "from": "Acme Dispatch <[email protected]>",    "to": ["[email protected]"],    "version": 5,    "props": { "orderId": "AC-4192", "customer": "Ada" }  }'

Atbilde

{  "object": "email",  "id": "msg_c5f21cc6…",  "status": "queued",  "from": "[email protected]",  "subject": "Order AC-4192 is on its way",  "template": { "id": "order-shipped", "version": 5 }}

Abi tvērumi, un neviens nav lieks: templates:write tāpēc, ka izsaucējs sniedzas pēc saglabāta satura, emails:send tāpēc, ka pasts aiziet no darbvietas. Atslēga, kas drīkst sūtīt savu saturu, joprojām nevar nosūtīt kāda cita veidni.

Jebkā automatizētā piestipriniet version. Ja to izlaiž, jūs izšķirat to, kas tajā brīdī ir publicēts, un tas ir tas, ko vēlaties, kad teksts pieder kādam citam, un nav tas, ko vēlaties tajā rītā, kad viņi to pārraksta.

subject pārraksta pašas veidnes tēmu tikai šim ziņojumam, un cancellableForSeconds, tracking un tags uzvedas tieši tāpat kā parastā sūtīšanā.

POST /emails pieņem template lauku, kas dara to pašu, izsaucējam, kurš ziņojumus jau būvē tur. Šis galapunkts pastāv tāpēc, lai sniegšanās pēc saglabāta satura neprasītu padot tāda ziņojuma formu, kuru jūs nemaz nesastādāt.

Kad sūtīšana tiek atteikta

Props ir līgums, nevis ieteikums, un katra zemāk minētā kļūme notiek, pirms kaut kas tiek izsūtīts. Alternatīva — ziņojums, kas aiziet ar tukšumu tur, kur bija pasūtījuma numurs, — netiek nekur ziņota un nav atsaucama.

Kods	Statuss	Kas notika
`resource_not_found`	404	Šajā savienojumā nav veidnes ar tādu id vai slug.
`template_not_published`	422	Tā pastāv un nekad nav publicēta, vai arī jūsu nosauktā versija joprojām ir melnraksts.
`template_version_not_found`	422	Jūs piestiprinājāt `version`, kāda šai veidnei nekad nav bijusi.
`missing_template_prop`	422	Prop, kas deklarēts kā `required`, iztrūka, bija null vai tukšs.
`unknown_template_prop`	422	Jūs padevāt atslēgu, ko versija nedeklarē. Ziņojumā ir nosauktas tās, kuras tā deklarē.
`unknown_template_slot`	422	Tas pats, bet par slotu.
`invalid_template_prop`	422	Vērtība, kas nav virkne, skaitlis vai būla vērtība. Objektu vai masīvu HTML nevar aizvietot.

param šajos ir template.props.<key>, tāpēc klients var norādīt uz lauku, kurā kļūdījies, neparsējot ziņojumu.