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

Версия от 13:43, 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>

Название	Тип	Значение	Примечание
code	string(4)	4-х значное число, может начинаться с нуля, код ошибки. Расшифровку можно посмотреть в разделе Коды ошибок

Перейти

ПланФикс API

@@ Строка 49: / Строка 49: @@
 </response>
 </source>
+{| class="wikitable" style="margin-top: 1em; width:100% "
+!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
+|-
+|code|| string(4) || 4-х значное число, может начинаться с нуля, код ошибки. Расшифровку можно посмотреть в разделе  [[ПланФикс API:Коды ошибок|Коды ошибок]] ||
+|-
+|}
 ----