ПланФикс API: Аутентификация: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
|||
Строка 21: | Строка 21: | ||
|passowrd || string || пароль пользователя, в открытом виде || | |passowrd || string || пароль пользователя, в открытом виде || | ||
|- | |- | ||
|signature || string(32) || md5 от имени функции, значений всех полей, исключая ''signature'' || | |signature || string(32) || md5 от имени функции, значений всех полей, исключая ''signature'' || подробное описание алгоритма формирования подписи смотри в разделе [[ПланФикс API:Формирование цифровой подписи]] | ||
|- | |- | ||
|} | |} |
Версия от 11:49, 30 августа 2010
Аутентификация
Аутентификация пользователя в системе. В результате выполнения данной функции он получает секретный ключ (ключ сессии).
<?xml version="1.0" encoding="UTF-8"?>
<request method="auth">
<account></account>
<login></login>
<password></password>
<signature></signature>
</request>
Название | Тип | Значение | Примечание | |
---|---|---|---|---|
account | string | имя аккаунта на котором будут выполняться все функции | ||
login | string | имя пользователя | под этим именем пользователь входит в сам планфикс. От него будут проходить дальнейшие запросы | |
passowrd | string | пароль пользователя, в открытом виде | ||
signature | string(32) | md5 от имени функции, значений всех полей, исключая signature | подробное описание алгоритма формирования подписи смотри в разделе ПланФикс API:Формирование цифровой подписи |
Ответ возвращаемый сервером
<?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></code>
</response>
Название | Тип | Значение | Примечание |
---|---|---|---|
code | string(4) | 4-х значное число, может начинаться с нуля, код ошибки. | Расшифровку можно посмотреть в разделе Коды ошибок |