Toto API slouží k úpravě informací o uživateli.
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 .
Různé akce pro změnu vlastností uživatele mohou mít další společné parametry identifikující
uživatele jehož data chcete změnit (pokud se nejedná o uživatele, který se přímo připojuje
k API, např. v případě že jako zákazník měníte data uživatele, který je registrován jako Váš).
Pro tyto parametry vizte
informace o uživateli (s výjimkou paramteru CTRL ).
V případě, že uživatel volající API mění informace sám sobě, není nutné ho dále identifikovat, je identifikován
ze základních parametrů .
Změna hesla
Volání slouží pro změnu hesla uživatele.
Parametry volání API
CTRL
Pevná hodnota: user_edit_password
password
Nové heslo.
Příklady volání API
ukázka 1: Změna hesla (implementace v PHP)
$login = 'someuser';
$call = microtime(true);
$password = md5(md5("originalpassword").$call);
$url = "https://api.profisms.cz/index.php?" . http_build_query(array(
"CTRL" => "user_edit_password",
"_login" => $login,
"_password" => $password,
"_service" => "general",
"_call" => $call,
// heslo se bude měnit uživateli volajícímu API
"password" => "newpassword",
));
/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_edit_password∓_login=someuser&
_password=02706666415386337290d919c9514edf&_service=general&_call=1301505714.88&
password=newpassword
*/
$json = join("", file($url));
Odpověď na požadavek API
Odpověď neobsahuje žádná specifická data. Úspěšnost požadavku je definována
v obecném popisu API .
Změna vlastností uživatele
Volání slouží pro změnu vlastnosti uživatele.
Seznam měnitelných vlastností a jejich význam naleznete
v dokumentaci
informací o uživateli .
Parametry volání API
CTRL
Pevná hodnota: user_edit_value
name
Název vlastnosti.
value
Hodnota vlastnosti.
Příklady volání API
ukázka 2: Změna vlastnosti (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_edit_value",
"_login" => $login,
"_password" => $password,
"_service" => "general",
"_call" => $call,
"id" => 8, // požadavek na změnu daných informací uživateli s ID 8
"name" => "delivery_address",
"value" => "http://company.com/dlr.php",
));
/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_edit_value&_login=user&
_password=36cb5039db59d01c8a3ada5fc80caf7d&_service=general&_call=1301506237.49&
name=delivery_address&value=http%3A%2F%2Fcompany.com%2Fdlr.php&id=8
*/
$json = join("", file($url));
Odpověď na požadavek API
Odpověď neobsahuje žádná specifická data. Úspěšnost požadavku je definována
v obecném popisu API .
Volání slouží pro změnu, smazání nebo přidání kontaktů uživatele.
CTRL
Pevná hodnota: user_edit_contact
Název a význam dalších parametrů odpovídá
struktuře kontaktu .
V případě, že chcete založit nový kontakt, zadejte do parametru id_contact
hodnotu 0 .
V případě, že upravujete existující kontakt, parametr type je ignorován
(nelze změnit typ kontaktu).
V případě, že chcete smazat existující kontakt, zadejte do parametru value
prázdný řetězec.
ukázka 3: Úprava kontaktu (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_edit_contact",
"_login" => $login,
"_password" => $password,
"_service" => "general",
"_call" => $call,
// změna kontaktu s ID 3
"id_contact" => "3",
"value" => "johndoe@johndoe.com",
// Pokud je toto jediný kontakt daného typu, není nutné zadávat parametr
// primary, kontakt je takto označen automaticky.
// Jelikož upravujeme existující kontakt, není nutné zadávat parametr type,
// nemá pro existující kontak význam.
));
/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_edit_contact&_login=user&
_password=246c826d378a33e733c8bddacf18841f&_service=general&_call=1301507796.28&
id_contact=3&value=johndoe%40johndoe.com
*/
$json = join("", file($url));
Úspěšnost požadavku je definována
v obecném popisu API .
V případě úspěšné odpovědí obsahuje objekt data
strukturu kontaktu ,
který byl změněn, přidán, nebo kontakt s id_contact = 0
, pokud byl
kontakt odstraněn.
ukázka 4: Odpověď
{
"error":
{
"code":0,
"message":"OK"
},
"data":
{
"id_contact":3,
"type":"email",
"value":"johndoe@johndoe.com",
"primary":1
},
"_key":"69723ee1e490782ea985f72347c2da92",
"_POST":[],
"_GET":
{
"CTRL":"user_edit_contact",
"_login":"user",
"_service":"general",
"_call":"1301507893.91",
"id_contact":"3",
"value":"johndoe@johndoe.com"
},
"_WEBSOCKETSMS":[],
"_time":0.254902839661
}
Úprava adres uživatele
Volání slouží pro změnu, smazání nebo přidání adresy uživatele.
Parametry volání API
CTRL
Pevná hodnota: user_edit_address
Název a význam dalších parametrů odpovídá
struktuře adresy .
V případě, že chcete založit novou adresu, zadejte do parametru id_address
hodnotu 0 .
V případě, že upravujete existující adresu, parametr type je ignorován
(nelze změnit typ adresy).
V případě, že chcete smazat existující adresu, zadejte do parametru city
prázdný řetězec.
Při upravě adresy je nutné zadávat všechny parametry. Pokud některý parametr vynecháte,
bude nastaven na prázdný řetězec nebo 0 .
Příklady volání API
ukázka 5: Změna adresy (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_edit_address",
"_login" => $login,
"_password" => $password,
"_service" => "general",
"_call" => $call,
"id_address" => 9,
"type" => "postal",
"primary" => 1,
"name" => "Jane",
"surname" => "Doe",
"title" => "",
"company" => "",
"street" => "Elm Street",
"building_number" => "546",
"city" => "City of Angels",
"zip" => "90211",
"country" => "us"
));
/**
URL bude vypadat
https://api.profisms.cz/index.php?CTRL=user_edit_address&_login=user&
_password=c5ffb4783e4acc541f72e4d094c9d241&_service=general&_call=1301587300.03&
id_address=9&type=postal&primary=1&name=Jane&surname=Doe&title=&
company=&street=Elm+Street&building_number=546&city=City+of+Angels&
zip=90211&country=us
*/
$json = join("", file($url));
Odpověď na požadavek API
Úspěšnost požadavku je definována
v obecném popisu API .
V případě úspěšné odpovědí obsahuje objekt data
strukturu adresy ,
která byla změněna, přidána, nebo adresu s id_address = 0
, pokud byla
adresa odstraněna.
ukázka 6: Odpověď
{
"error":
{
"code":0,
"message":"OK"
},
"data":
{
"id_address":9,
"type":"postal",
"primary":1,
"name":"Jane",
"surname":"Doe",
"title":"",
"company":"",
"street":"Elm Street",
"building_number":"546",
"city":"City of Angels",
"zip":"90211",
"country":"us"
},
"_key":"5bc040b2efb1b458951501df14aa9be9",
"_POST":[],
"_GET":
{
"CTRL":"user_edit_address",
"_login":"user",
"_service":"general",
"_call":"1301587300.03",
"id_address":"9",
"type":"postal",
"primary":"1",
"name":"Jane",
"surname":"Doe",
"title":"",
"company":"",
"street":"Elm Street",
"building_number":"546",
"city":"City of Angels",
"zip":"90211",
"country":"us"
},
"_WEBSOCKETSMS":[],
"_time":0.0763208866119
}
Použití API pro vytvoření aplikace komunikující s ProfiSMS je podmíněno souhlasem s podmínkami pro použití služby ProfiSMS.
Verze: 1.000 | 2010-03-30 | support@profisms.cz