From bf5a7349ad920d4d4d22cade6f488424b50ef44e Mon Sep 17 00:00:00 2001 From: 4026 Date: Mon, 4 Dec 2017 13:26:31 +0100 Subject: [PATCH] =?UTF-8?q?Alap=20adatok=20=C3=A9s=20feliratkoz=C3=A1s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2d1a702..589f5a4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -ninjaMail_public +ninjaMail API =============== -Information about the system. \ No newline at end of file +Ebben a fájlban olvashat arról, hogyan használhatja a levelező +alkalmazásprogramozási interfészét. +A példákban szereplő lekérések PHP programozási szemszögből készültek, viszont +felhasználható más nyelven íródott projektekben is, amennyiben az rendelkezik +CURL könyvtárral vagy más, GET és POST hívást támogató eszközzel. + + +## Bevezetés +Az API használatához regisztráció után generálni kell egy kulcsot. Ez a +Beállítások -> API menüből érhető el. A generált kulcsot tartsa titokban! +Míg API kulccsal nem lehet bejelentkezni a webes felületen, az API felületen a +legtöbb funkció elérhető. A kulcs felhasználásával lehetőség nyílik többek +között feliratkozók hozzáadására, törlésére. + + +## API URL +Az URL kulcsgenerálás után ugyan azon a felületen lesz látható. +Példa: http://example.org/a/?key= +Ahol: ^ ^ ^ API Kulcs + ^ Részegység + Szolgáltató címe. + + +### Feliratkozó hozzáadása +Feliratkozó hozzáadása esetén tudni kell a lista azonosítóját. Ez a webes +felületre történő belépés után a Listák menüpontban a kettőskereszt oszlopban +látható. A feliratkozást végző gyár: subscribe +A kérés a következőképpen alakul: +POST: http://example.org/a/subscribe?key= +DATA: name=&email=&activated=<1|0> +Az activated paraméter 1-es állásban megerősítettként rögzíti a feliratkozót, +míg 0 állásban küld megerősítő hivatkozást a megadott címre.