ПланФикс API: Аутентификация: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
Строка 50: Строка 50:


=== Перейти ===
=== Перейти ===
----
*[[Список функций]]
*[[Список функций]]
*[[Коды ошибок]]
*[[Коды ошибок]]
*[[ПланФикс API:Пример аутентификации на php|Пример кода на PHP]]
*[[ПланФикс API:Пример аутентификации на php|Пример кода на PHP]]

Текущая версия от 16:47, 29 июля 2022

Аутентификация

Аутентификация пользователя в системе. В результате выполнения данной функции он получает секретный ключ (ключ сессии).

<?xml version="1.0" encoding="UTF-8"?>
<request method="auth.login">
  <account></account>
  <login></login>
  <password></password>
  <signature></signature>
</request>
Название Тип Значение Примечание
account string имя аккаунта на котором будут выполняться все функции (если вход в планфикс осуществляется по адресу https://name.planfix.ru имя аккаунта, которое нужно передавать в это поле: name)
login string имя пользователя под этим именем пользователь входит в сам планфикс. От него будут проходить дальнейшие запросы
password string пароль пользователя, в открытом виде
signature string(32) не обязательна, md5 от имени функции, значений всех полей, исключая signature подробное описание алгоритма формирования подписи смотри в разделе ПланФикс API:Формирование цифровой подписи


Ответ возвращаемый сервером

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <sid></sid>
</response>
Название Тип Значение Примечание
sid string(32) имя сессии после удачной аутентификации это значение используется при выполнении следующих запросов для идентификации пользователя


Перейти