Průvodce - API

Všeobecné informace o Netquest API

Netquest API umožňuje přístup k funkcím webové platformy Netquest.cz použitím JSON rozhraní. Výsledkem toho je možné vytvořit nebo propojit externí aplikace napojené (např. CRM systém) s účtem uživatele Netquest.cz.

URL služby

Přístupový bod API (základní URL adresa) je umístěn na adrese:
https://www.netquest.cz/api

Přístup probíhá prostřednictvím šifrovaného připojení (https://).

Jak je organizováno rozhraní Netquest API

REST, REST-like
Operace v Netquest API jsou organizovány dle stylu REST. To znamená, že adresa URL identifikuje určitý zdroj, zatímco aktivita, která má být provedena, je určena na základě příslušných URL adres a metod (GET, POST).

  • GET – načte informace o zdroji nebo vymaže zdroj s daným identifikátorem
  • POST – vytvoří nový nebo změní stávající zdroje

Další informace o programu REST naleznete na adrese:

Formát vrácené odpovědi (výstup)

Netquest API vrací odpověď ve formátu – JSON.
V budoucnosti, v závislosti na poptávce, může být formát odpovědí rozšířen o XML.

Kódování

Všechna data odesílaná prostřednictvím Netquest API by měla být kódovaná v UTF-8.

Autentifikace

Ověřování se provádí pomocí protokolu oAuth (http://oauth.net/). Pro potřeby mobilních a desktopových aplikací byla změněna tak, aby se autorizace mohla provádět pomocí přihlašovacího jména a hesla uživatele.

Všechny dotazy odeslané do Netquest musí být podepsány klíčem consumer_secret nebo párem klíčů consumer_secret a token_secret. Další informace o tom, jak podepsat požadavek, naleznete v tématu Autorizace Netquest API.

Získané autorizační klíče by měly aplikaci ukládat do databáze. Klíč consumer je přiřazen k aplikaci, zatímco klíč token je přidělen uživateli pomocí aplikace.

Chybové hlášky

Výsledek provedeného dotazu lze zjistit na základě kódu chyby HTTP.
V Netquest API jsou použity následující kódy:

  • 200 OK – Dotaz byl proveden správně
  • 400 Špatný požadavek – Parametr přijal nesprávnou hodnotu nebo hodnota parametru není ve specifikované sadě.
  • 401 Neautorizováno – Žádné oprávnění ani práva ke zdroji.
  • 402 Vyžadována platba – Omezení zakoupeného balíčku zabraňují přístupu ke zdroji.
  • 404 Nenalezeno – Zdroj nebyl nalezen nebo neexistuje.
  • 406 Nepřijatelný – Požadovaný parametr nebyl předán.
  • 409 Konflikt – Kód byl vrácen při neúspěšném pokusu o zápis dat (např. aktivace dotazníku).
  • 500 Interní chyba serveru – Kód vrátil interní chybu serveru.

Pokud máte dotazy, napište nám a popište svůj nápad nebo problém. Každý návrh nám umožní lépe přizpůsobit API webových stránek Vašim potřebám.

Pomohl Vám tento článek?

Děkujeme za odpověď