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

Версия от 06:18, 6 июня 2014

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

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

<?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	имя пользователя	под этим именем пользователь входит в сам планфикс. От него будут проходить дальнейшие запросы
passowrd	string	пароль пользователя, в открытом виде
signature	string(32)	md5 от имени функции, значений всех полей, исключая signature	подробное описание алгоритма формирования подписи смотри в разделе ПланФикс API:Формирование цифровой подписи

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

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <sid></sid>
</response>

Название	Тип	Значение	Примечание
sid	string(32)	имя сессии после удачной аутентификации	это значение используется при выполнении следующих запросов для идентификации пользователя

Перейти

Список функций

Коды ошибок

Пример кода на PHP

@@ Строка 15: / Строка 15: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|account|| string || имя аккаунта на котором будут выполняться все функции||
+|account|| string || имя аккаунта на котором будут выполняться все функции|| (если вход в планфикс осуществляется по адресу https://name.planfix.ru имя аккаунта, которое нужно передавать в это поле: name)
 |-
 |login || string || имя пользователя || под этим именем пользователь входит в сам планфикс. От него будут проходить дальнейшие запросы ||