Alap adatok és feliratkozás

README.md

@@ -1,4 +1,35 @@
-ninjaMail_public
+ninjaMail API
 ===============
 
-Information about the system.
+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/<gyár>?key=<kulcs>
+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=<kulcs>
+DATA: name=<Feliratkozó neve>&email=<Feliratkozó E-mail címe>&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.