API dokumentáció

A Szinonimakereső alkalmazásprogramozási felülete (API) segítségével elérheted folyamatosan bővülő szinonimaszótár adatbázisunkat. Az API használatához programozási tudás szükséges. Az API-val való kommunikáció http protokoll segítségével történik.

API endpoint

JSON válasz estén:

https://szinonimakereso.hu/api/v1.json

XML-RPC válasz estén:

https://szinonimakereso.hu/api/v1.xml

API hívás példa:

https://szinonimakereso.hu/api/v1.json?key=SERVICE_KEY&word=alma

Paraméterek

Paraméter Adattípus Szükséges? Leírás
key string igen Az API használatához szükséges egyedi azonosító, úgynevezett “Service Key”, melyet az oldalra való regisztráció (ill. bejelentkezés) után tudsz generálni.
word string igen A keresendő szó, melynek szinonimáit szeretnéd megkapni.

Válaszkódok és üzenetek:

Code 200 - OK - Minden rendben, a lekérdezés sikerült.
Code 400 - Bad Request - Hiányzó szó.
Code 403 - Forbidden - Hozzáférés megtagadva. Hiányzó vagy érvénytelen “Service Key”.
Code 404 - Not found - Nem található a keresendő szó.
Code 429 - Too Many Requests - Túl sok lekérdezés, elérted a napi limitet.

Válaszüzenet (JSON példa):

<?php
{
 
"code": 200,
 
"text": "OK",
 
"data": [
    {
     
"szo": "kel",
     
"szofaj": "ige",
     
"szinonimak": [
    {
     
"szinonima": "virrad",
     
"stilusminosites": ""
   
},
    {
     
"szinonima": "felkel",
     
"stilusminosites": ""
   
},
    {
     
"szinonima": "felserken",
     
"stilusminosites": "régi, régies"
   
},
    {
     
"szinonima": "lábad",
     
"stilusminosites": "régi, régies"
   
}
      ]
    },
    {
     
"szo": "kel",
     
"szofaj": "főnév",
     
"szinonimak": [
    {
     
"szinonima": "kelkáposzta",
     
"stilusminosites": ""
   
},
    {
     
"szinonima": "olaszkáposzta",
     
"stilusminosites": "tájnyelvi"
   
},
    {
     
"szinonima": "édeskáposzta",
     
"stilusminosites": "tájnyelvi"
   
},
    {
     
"szinonima": "plutyka",
     
"stilusminosites": "tájnyelvi"
   
}
      ]
    }
  ]
}
?>