ПланФикс API: Аутентификация — различия между версиями
Материал из ПланФикс
(→Аутентификация) |
(→Аутентификация) |
||
Строка 35: | Строка 35: | ||
</response> | </response> | ||
</source> | </source> | ||
+ | |||
+ | |||
+ | {| border="1" cellpadding="5" cellspacing="0" | ||
+ | !Название !! Тип !! Значение !! Примечание | ||
+ | |- | ||
+ | |sid || string(32) || имя сессии после удачной аутентификации || это значение используется при выполнении следующих запросов для идентификации пользователя | ||
+ | |- | ||
+ | |} | ||
Версия 13:31, 19 августа 2010
Аутентификация
Аутентификация пользователя в системе. В результате выполнения данной функции он получает секретный ключ (ключ сессии).
<?xml version="1.0" encoding="UTF-8"?>
<request method="auth">
<account><!-- имя аккаунта --></account>
<login><!-- имя от которого будет происходить дальнейшие запросы --></login>
<password></password>
<signature><!-- md5 --></signature>
</request>
Название | Тип | Значение | Примечание |
---|---|---|---|
account | string | имя аккаунта на котором будут выполняться все функции | |
login | string | имя пользователя | под этим именем пользователь входит в сам планфикс |
passowrd | string | пароль пользователя, в открытом виде | |
signature | string(32) | md5 от имени функции, значений всех полей, исключая signature |
Ответ возвращаемый сервером
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<sid><!-- ключ сессии --></sid>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
sid | string(32) | имя сессии после удачной аутентификации | это значение используется при выполнении следующих запросов для идентификации пользователя |
Если произошла ошибка
<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
<code><!-- xxxx значный код ошибки --></code>
</response>