From fdd6841a35e0c13a0809bc6f239b67b1ae4ab192 Mon Sep 17 00:00:00 2001 From: 4026 Date: Mon, 4 Dec 2017 13:31:35 +0100 Subject: [PATCH] Formatting --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 7a9b69e..b646364 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,35 @@ ninjaMail API =============== - + 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. - - +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. - - +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. - - +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>` +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.