Přihlášení uživatele

Toto API slouží k přihlášení uživatele. Po úspěšném přihlášení není nutné následně v API požadavcích zasílat přihlašovací údaje.

Základní popis a tvar API volání a odpovědi najdete popsané samostatně.

Služba

User info API patří do služby Obecné (general).

Parametry volání API

Volání musí obsahovat všechny základní parametry.

CTRL

Pevná hodnota: user_login

Příklady volání API

ukázka 1: Přihlášení uživatele (implementace v PHP)
$login = 'user';
$call = microtime(true);
$password = md5(md5("passwd").$call);

$url = "https://api.profisms.cz/index.php?" . http_build_query(array(
  "CTRL" => "user_login",
  "_login" => $login,
  "_password" => $password,
  "_service" => "general",
  "_call" => $call,
));

/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_login&_service=general
  &_login=user&_password=67060092181f11e9a41ea8789a111415
  &_call=1302885011.45
*/

$json = join("", file($url));

Odpověď na úspěšný požadavek na API

Základní formát odpovědi naleznete v obecném popisu API.

Popis řetězce data

Parametr data ve výsledku obsahuje řetězec, který identifikuje založenou session. Tuto session je pak možné používat místo přihlašovacích údajů.

Ukázka odpovědí

ukázka 2: Odpověď
{
  "error":
  {
    "code":0,
    "message":"OK"
  },
  "data":"ee2c6144c0f37dd21eb9f03959fad885",
  "_key":"fdb0ebd1840e4bae0985de22f7695616",
  "_POST":[],
  "_GET":
  {
    "CTRL":"user_login",
    "_service":"general",
    "_login":"user",
    "_call":"1302885011.45"
  },
  "_WEBSOCKETSMS":[],
  "_time":0.0836260318756
}

Získaná session je z bezpečnostních důvodů platná pouze 10 minut. Platnost se prodlužuje automaticky s každým požadavkem o dalších 10 minut. Pokud neproběhne požadavek během 10 minut, další použití této session vyvolá chybu (USER_MISSING), session je zničena a uživatel odhlášen. V takovém případě nutné buď provádět požadavky standardním způsobem, nebo uživatele znovu přihlásit.

Odpověď na neúspěšný požadavek na API

Základní formát odpovědi naleznete v obecném popisu API.

Použití session

V případě úspěšného přihlášení je možné danou session používat pro všechna volání API místo běžných příhlašovacích parametrů _login a _password.

ukázka 3: Ukázka použití session - odeslání SMS
  
$call = microtime(true);
$url = "https://api.profisms.cz/index.php?" . http_build_query(array(
  "CTRL" => "sms",
  "_session" => "ee2c6144c0f37dd21eb9f03959fad885",
  "_call" => $call,
  "_service" => "sms",
  
  "msisdn" => "+420605582922",
  "text" => "sms text",
));

/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=sms&_session=ee2c6144c0f37dd21eb9f03959fad885
  &_call=1302885818.68&_service=sms&msisdn=%2B420605582922
  &text=sms+text
*/

$json = join("", file($url));
ukázka 4: Ukázka použití session - informace o uživateli
  
$call = microtime(true);
$url = "https://api.profisms.cz/index.php?" . http_build_query(array(
  "CTRL" => "user_info",
  "_session" => "ee2c6144c0f37dd21eb9f03959fad885",
  "_call" => $call,
  "_service" => "general",
));

/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_info
  &_session=ee2c6144c0f37dd21eb9f03959fad885
  &_call=1302886058.76&_service=general
*/

$json = join("", file($url));

Výsledky volání při použití session se neliší od výsledků běžných voláni.