Průvodce - API

Uživatel

Název URL Popis
Informace uživatele /user Detailní informace o přihlášeném uživateli, identifikovaném dle parametrů token a token_secret
Tvorba uživatelského účtu /user/create Vzdálená tvorba uživatelského účtu. Ve výchozím nastavení je vytvořen Enterprise účet.
Informace o vyplněních účtu uživatele /user/responses Tato operace vrací informace o vyplněních z posledního týdne pro všechny dotazníky účtu uživatele.

Popis parametrů odpovědi

RRRR-MM-DD pro Business a Enterprise účty

Název/cesta Popis Možné hodnoty
id ID uživatele
email E-mailová adresa uživatele
md5_password Heslo zkrácené funkcí md5, které se používá pro přihlášení prostřednictvím API
login_key md5 klíč sloužící pro přihlášení. Struktura přihlašovacího odkazu do uživatelského panelu je: https://www.netquest.cz/prihlaseni/link/:login_key/:id, kde login_key je hodnota parametru login_key a id a je ID uživatele.
registration_date Datum registrace na webové stránce
activation_date Datum aktivace účtu (potvrzení registrace)
expiration_date Datum vypršení účtu – pro Business a Enterprise účty
type Typ účtu business – Business účet
enterprise – Enterprise účet
company Název společnosti
street Adresa společnosti
postal_code Poštovní kód
city Město
company_registration_number
surveys_count Počet dotazníků účtu
id_response ID vyplnění použitého k vyplnění vícestránkových dotazníků.
Použitý s respondent_key parametru
id_survey ID dotazníku
token Unikátní token, který přesně identifikuje respondenta. Použitý pro jednorázové vyplnění dotazníku respondentem.
Tento parametr je aktivní pouze pro nejvyšší úroveň ochrany dotazníku.
date_survey_open Datum a hodina prvního otevření dotazníku. Tento parametr je aktivní pouze pro dotazníky s nejvyšší úrovní ochrany. null – Dotazník nebyl otevřen respondentem
2012-12-06 12:00:00 – Datum a hodina otevření dotazníku
date_survey_answer Datum a hodina vyplnění dotazníku. Tento parametr je aktivní pouze pro dotazníky s nejvyšší úrovní ochrany. null – Dotazník nebyl vyplněna respondentem
2012-12-06 12:00:00 – Datum a hodina otevření dotazníku

Informace uživatele

URL

(GET) https://www.netquest.cz/api/user

Parametry

Žádné
Ukázka odpovědi

{
  "email":"petr.novak@netquest.cz",
  "registration_date":"2010-01-01 00:00:00",
  "activation_date":"2010-01-01 01:00:00",
  "expiration_date":"2012-01-01 00:00:00",
  "type":"Business",
  "company":"Digital Heads, s.r.o.",
  "street":"Vinohradská 2828/151",
  "postal-code":"130 00",
  "city":"Praha",
  "company_registration_number":"000-000-00-00",
  "surveys_count":"11"
}

Chybové hlášky

Žádné

Tvorba uživatelského účtu

URL

(GET) https://www.netquest.cz/api/user/create

Nepovinné parametery (POST)

Název Popis
email E-mailová adresa, na kterou bude účet zaregistrován
firstname Jméno majitele účtu
fm_api_key Klíč do služby API Freshmail. Nepovinný parametr
fm_api_secret Secret klíč do API služby Freshmail. Nepovinný parametr

Ukázka odpovědi

 	 	
{
  "id":"1234"
  "email":"martin.novak@netquest.cz",
  "md5_password":"663964500831381fc657ce86690fb0c0",
  "login_key":"657ce86690fb0c0663964500831381fc",
  "type":"biznes"
}

Chybové hlášky

  • 404 Nenalezeno – Neplatná e-mailová adresa nebo je již adresa zaregistrována.
  • 406 Nepřijatelné – Parametr :email nebyl předán.
  • 500 Interní chyba serveru – Interní chyba serveru.

Informace o vyplněních účtu uživatele

URL

(GET) https://www.netquest.cz/api/user/responses

Nepovinné parametery (POST)

Název Popis
title Název dotazníku
date_survey_open_lower Minimální datum začátku vyplnění dotazníku. Datum musí být odesláno ve formátu YYYY-MM-DD (např. 2013-11-20).
Po odeslání parametru budou vrácena vyplnění z tohoto a následujících dnů.
date_survey_open_upper Maximální datum začátku vyplnění dotazníku. Datum musí být odesláno ve formátu YYYY-MM-DD (např. 2013-11-20).
Po odeslání parametru budou vrácena vyplnění z tohoto a předchozích dnů.
external_key Hodnota předávaná do dotazníku jako parametr external_key. Díky tomu můžete třídit všechna vyplnění z daného zdroje. Více informací o external_key naleznete zde.
sm_client_id Hodnota předávaná do dotazníku v případě zapnuté integrace se službou Sales Manago. Díky tomu můžete třídit všechna vyplnění s daným profilem.
limit Limit v počtu záznamů
offset Offset v záznamech

Ukázka odpovědi

 	 	[
 	 	   {
 	 	      id_response: 123,
 	 	      id_survey: 123,
 	 	      token: "2a5089",
 	 	      user_token: "ola1983",
 	 	      date_survey_open: "2012-12-06 12:00:00",
 	 	      date_survey_answer: "2012-12-06 12:00:00"
 	 	   }
 	 	]

Chybové hlášky

Žádné

Pomohl Vám tento článek?

Děkujeme za odpověď