Netquest API umožňuje prístup k funkciám webovej platformy Netquest.sk použitím JSON rozhrania. Výsledkom toho je možné vytvoriť alebo prepojiť externé aplikácie (napr. CRM systém) napojenej s účtom používateľa Netquest.sk.
URL služby
Přístupový bod API (základní URL adresa) je umístěn na adrese:https://www.netquest.sk/api
Prístup prebieha prostredníctvom šifrovaného pripojenia (https: //).
Ako je organizované rozhranie Netquest API
REST, REST-like
Operácie v Netquest API sú organizované podľa štýlu REST. To znamená, že adresa URL identifikuje určitý zdroj, zatiaľ čo aktivita, ktorá má byť vykonaná, je určená na základe príslušných URL adries a metód (GET, POST).
- GET – načíta informácie o zdroji alebo vymaže zdroj s daným identifikátorom
- POST – vytvorí nový alebo zmení existujúce zdroje
Ďalšie informácie o programe REST nájdete na adrese:
Formát vrátenej odpovede (výstup)
Netquest API vracia odpoveď vo formáte – JSON.
Kódovanie
Všetky dáta odosielané prostredníctvom Netquest API by mali byť kódované v UTF-8.
Autentifikácia
Overovanie sa vykonáva pomocou protokolu OAuth (http://oauth.net/). Pre potreby mobilných a desktopových aplikácií boli zmenená tak, aby sa autorizácia mohla vykonávať pomocou prihlasovacieho mena a hesla užívateľa.
Všetky otázky odoslané do Netquest musia byť podpísané kľúčom consumer_secret alebo párom kľúčov consumer_secret a token_secret. Ďalšie informácie o tom, ako podpísať požiadavku, nájdete v téme Autorizácia Netquest API.
Získané autorizačné kľúče by mala aplikácia ukladať do svojej databázy. Kľúč consumer je priradený k aplikácii, zatiaľ čo kľúč token je pridelený užívateľovi pomocou aplikácie.
Chybové hlášky
Výsledok vykonaného dopytovania možno zistiť na základe kódu chyby HTTP.
V Netquest API sú použité nasledujúce kódy:
- 200 OK – Dopytovanie bolo vykonané správne
- 400 Zlá požiadavka – Parameter prijal nesprávnu hodnotu alebo hodnota parametra nie je vo špecifikovanej sade.
- 401 Neautorizovaný – Žiadne oprávnenie ani práva k zdroju.
- 402 Vyžadovaná platba – Obmedzenia účtu zabraňujú prístupu k tejto možnosti platformy.
- 404 Nenájdené – Zdroj nebol nájdený alebo neexistuje.
- 406 Neprijateľný – Požadovaný parameter nebol odovzdaný.
- 409 Konflikt – Kód bol vrátený pri neúspešnom pokuse o zápis dát (napr. aktivácia dotazníka).
- 500 Interná chyba servera – Kód vrátil internú chybu servera.
Ak máte otázky, napište nám a popíšte svoj nápad alebo problém. Každý návrh nám umožní lepšie prispôsobiť API webových stránok Vašim potrebám.