sandros/ninjaMail_public
sandros
/
ninjaMail_public
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Formatting

This commit is contained in:
4026 2017-12-04 13:31:35 +01:00
parent 6b88ef70e7
commit fdd6841a35
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,35 +1,35 @@
ninjaMail API ninjaMail API
=============== ===============
Ebben a fájlban olvashat arról, hogyan használhatja a levelező Ebben a fájlban olvashat arról, hogyan használhatja a levelező
alkalmazásprogramozási interfészét. alkalmazásprogramozási interfészét.
A példákban szereplő lekérések PHP programozási szemszögből készültek, viszont 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 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 ## Bevezetés
Az API használatához regisztráció után generálni kell egy kulcsot. Ez a 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! 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 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 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 ## API URL
Az URL kulcsgenerálás után ugyan azon a felületen lesz látható. 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> Példa: http://example.org/a/<gyár>?key=<kulcs>
Ahol: ^ ^ ^ API Kulcs Ahol: ^ ^ ^ API Kulcs
^ Részegység ^ Részegység
Szolgáltató címe. Szolgáltató címe.
### Feliratkozó hozzáadása ### Feliratkozó hozzáadása
Feliratkozó hozzáadása esetén tudni kell a lista azonosítóját. Ez a webes 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 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 látható. A feliratkozást végző gyár: subscribe
A kérés a következőképpen alakul: A kérés a következőképpen alakul:
`POST: http://example.org/a/subscribe?key=<kulcs>` `POST: http://example.org/a/subscribe?key=<kulcs>`
`DATA: name=<Feliratkozó neve>&email=<Feliratkozó E-mail címe>&activated=<1|0>` `DATA: name=<Feliratkozó neve>&email=<Feliratkozó E-mail>&activated=<1|0>`
Az activated paraméter 1-es állásban megerősítettként rögzíti a feliratkozót, 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. míg 0 állásban küld megerősítő hivatkozást a megadott címre.