From 24bb70269822a2f0b4a48240ea206480b3408a7e Mon Sep 17 00:00:00 2001 From: 4026 Date: Mon, 8 Apr 2019 08:32:42 +0000 Subject: [PATCH] New api feautres + bugs --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 50 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9c057a9..71dcd2e 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ Sikeres kérés: -tömb- Levelek létrehozására alkalmas. A leveleket kezelő gyár: newsletter A kérés a következőképpen alakul: -`POST: http://example.org/a/list?key=` +`POST: http://example.org/a/newsletter?key=` `DATA: new&subject=&message=&message_text=` #### Várható válaszok @@ -103,7 +103,7 @@ Túl rövid üzenet: `message_too_short` Levelek küldésére alkalmas. A leveleket kezelő gyár: newsletter A kérés a következőképpen alakul: -`POST: http://example.org/a/list?key=` +`POST: http://example.org/a/newsletter?key=` `DATA: send&id=&start=` #### Várható válaszok @@ -114,18 +114,63 @@ Sikeres kérés: `success`, Már várólistán: `already_queued`, Sikertelen ké Levelek listázására alkalmas. A leveleket kezelő gyár: newsletter A kérés a következőképpen alakul: -`POST: http://example.org/a/list?key=` +`POST: http://example.org/a/newsletter?key=` `DATA: get` #### Várható válaszok -Sikeres kérés: `success`, Már várólistán: `already_queued`, Sikertelen kérés: `failed` +Sikeres kérés: -tömb- + + +### Kampány létrehozása +Kampányok létrehozására alkalmas. +A leveleket kezelő gyár: campaign +A kérés a következőképpen alakul: +`POST: http://example.org/a/campaign?key=` +`DATA: new&name=` + +#### Várható válaszok +Sikeres kérés: `success`, `id`, Sikertelen kérés: `failed` + + +### Kampány törlése +Kampányok törlésére alkalmas. +A leveleket kezelő gyár: campaign +A kérés a következőképpen alakul: +`POST: http://example.org/a/campaign?key=` +`DATA: remove&id=` + +#### Várható válaszok +Sikeres kérés: `success`, Sikertelen kérés: `failed` + + +### Kampány frissítése (csatolás) +Kampányok listához történő csatolására alkalmas. +A leveleket kezelő gyár: campaign +A kérés a következőképpen alakul: +`POST: http://example.org/a/campaign?key=` +`DATA: update&id=&lists=` + +#### Várható válaszok +Sikeres kérés: `success`, Sikertelen kérés: `failed` + + +### Kampány csatolása levélhez +Kampányok levélhez történő csatolására alkalmas. +A leveleket kezelő gyár: campaign +A kérés a következőképpen alakul: +`POST: http://example.org/a/campaign?key=` +`DATA: relations&campaign=&newsletter=` + +#### Várható válaszok +Sikeres kérés: `success`, Sikertelen kérés: `failed` ### E-mail küldése Egyéni e-mail küldését, valamint annak sikerességének vizsgálatát teszi lehetővé. Az üzenet HTML és Plain text formában kerül kiküldésre. Ha a `message_text` értéke üres, a HTML formátumú levél tartalmával minusz HTML tag-ek lesz azonos. Az üzenet -csak a HTML body részét tartalmazza! +csak a HTML body részét tartalmazza! Nagy mennyiségű üzenet küldésére használja a +newsletter, list és campaigns gyárakat! A küldést és ellenőrzést végző gyár: send A kérés a következőképpen alakul: `POST: http://example.org/a/send?key=`