A Poet szinonimaszótár API-ja segítségével elérheted folyamatosan fejlődő szinonimaszótárunk adatbázisát, és (bizonyos megkötések mellett) ingyenesen és szabadon felhasználhatod azt saját weblapodon, alkalmazásodban vagy más projektedben. Az API használatához programozási tudás szükséges.
A felhasználás feltételei
Az API napi 5000 lekérésig bárki által használható. Ennél több lekérést igénylő alkalmazások esetében kérünk, hogy előzetesen egyeztess velünk!
A felhasználás feltétele, hogy az adatokat felhasználó alkalmazás felületén forrásmegjelölésként jól látható módon fel legyen tüntetve a Poet.hu szinonimaszótár. Amennyiben van rá mód, megköszönjük, ha egy ránk mutató linket is elhelyezel alkalmazásod felületén. Az elkészült és publikált alkalmazásod elérhetőségét, kérünk, oszd meg velünk is!
Az API használatához regisztrált felhasználónév szükséges. Egy alkalmazás csak egyetlen felhasználónevet használhat. Tilos az API-t a szótár adatbázisainak reprodukálására, vagy hasonló jellegű adatbázis, illetve weboldal létrehozására (illetve ezek bővítéséhez) használni (a tőlünk kapott adatokat ugyanakkor akár hosszabb távon is eltárolhatod a saját szervereden, ha ez gyorsítja az alkalmazásod működését, és az alkalmazás amúgy megfelel az API-nk felhasználási feltételeinek).
Az Poet írásos engedélye nélkül az API felhasználásával készült alkalmazás nevében nem szerepelhet a "Poet" szó, nem használhatja fel az oldal grafikai elemeit és nem kelthet olyan benyomást, mintha az a Poet hivatalos terméke lenne.
A Poet.hu nem vállal felelősséget a szolgáltatás elérhetőségével vagy működésével kapcsolatban, és fenntartja a jogot, hogy a szolgáltatás nyújtását egyes felhasználók számára akár indoklás nélkül is megtagadja. A beérkezett parancsokat felhasználónévvel és IP címmel együtt 30 napig tároljuk.
Terheléssel kapcsolatos elvárások
Elsődleges célunk a weboldal zavartalan működésének fenntartása. Amennyiben az API használata ezt veszélyeztetni látszik, egyes azonosítókat vagy a szolgáltatást átmenetileg kikapcsolhatjuk. Annak érdekében, hogy erre ne legyen szükség, kérünk, a fejlesztéskor igyekezz alkalmazásod gyorsítótárazását úgy megoldani, hogy lehetőleg minél kevesebb lekérést kelljen hozzánk intézned. Az oldalon hajnali 2 és reggel 6 óra között van a legkevesebb látogató, ezért amennyiben az alkalmazásod jellege engedi, ezen időpontok közé időzítsd a lekéréseket. Az esti órákban (18-22-ig) igyekezz minél kevesebb lekérést küldeni felénk!
API dokumentáció
Az API-val való kommunikáció a http protokoll segítségével történik. Az API kéréseket ugyanúgy kell intézni, mintha bármilyen más weboldal tartalmát szeretnéd lekérni. Az API a paramétereket urlencode-olva várja, a választ UTF-8 kódolással fogja elküldeni.
URL: https://api.poet.hu/szinonima.php
Kötelező paraméterek:
- f - A Poet.hu-s felhasználóneved.
- j - A jelszavadból képzett egyedi kód. Ha ezt az oldalt bejelentkezés után látogatod meg, a paraméter értékét kiírjuk neked ide.
- s - A szó, aminek a szinonimáit szeretnéd megkapni.
Példa:
https://api.poet.hu/szinonima.php?f=felhasznalonev&j=jelszo&s=csirke
Válaszpélda:
<?xml version="1.0" encoding="UTF-8"?> <szinonimak> <szocsoport> <szinonima>pipi</szinonima> <szinonima>tojó</szinonima> <szinonima>tyúk</szinonima> </szocsoport> </szinonimak>