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

Текущая версия на 14:00, 13 февраля 2018

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

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

<?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)	имя сессии после удачной аутентификации	это значение используется при выполнении следующих запросов для идентификации пользователя

Перейти

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

Коды ошибок

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

@@ Строка 1: / Строка 1: @@
+{{#seo:
+|title=ПланФикс API: Аутентификация
+|titlemode=append
+|keywords=планфикс, ПланФикс API: Аутентификация, API, разработчикам
+|description=ПланФикс API: Аутентификация
+}}
 == Аутентификация ==
-Аутентификация пользователя в системе. В результате выполнения данной функции он получает секретный ключ (ключ сессии).
+Аутентификация пользователя в системе.
+В результате выполнения данной функции он получает секретный ключ (ключ сессии).
 <source lang="xml">
 <?xml version="1.0" encoding="UTF-8"?>
-<request method="auth">
+<request method="auth.login">
    <account></account>
    <login></login>
@@ Строка 14: / Строка 21: @@
 !width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
 |-
-|account|| string || имя аккаунта на котором будут выполняться все функции||
+|account|| string || имя аккаунта на котором будут выполняться все функции|| (если вход в планфикс осуществляется по адресу https://name.planfix.ru имя аккаунта, которое нужно передавать в это поле: name)
 |-
 |login || string || имя пользователя || под этим именем пользователь входит в сам планфикс. От него будут проходить дальнейшие запросы ||
 |-
-|passowrd || string || пароль пользователя, в открытом виде ||
+|password || string || пароль пользователя, в открытом виде ||
 |-
-|signature || string(32) || md5 от имени функции, значений всех полей, исключая ''signature'' ||
+|signature || string(32) || не обязательна, md5 от имени функции, значений всех полей, исключая ''signature'' || подробное описание алгоритма формирования подписи смотри в разделе [[ПланФикс API:Формирование цифровой подписи]]
 |-
 |}
@@ Строка 30: / Строка 37: @@
 <?xml version="1.0" encoding="UTF-8"?>
 <response status="ok">
-   <sid><!-- ключ сессии --></sid>
+   <sid></sid>
 </response>
 </source>
@@ Строка 41: / Строка 48: @@
-Если произошла ошибка
-<source lang="xml">
+=== Перейти ===
-<?xml version="1.0" encoding="UTF-8"?>
+----
-<response status="error">
-  <code></code>
+*[[Список функций]]
-</response>
-</source>
-{| class="wikitable" style="margin-top: 1em; width:100% "
-!width="150"|Название !!width="200"| Тип !!width="50%"| Значение !! Примечание
-|-
-|code|| string(4) || 4-х значное число, может начинаться с нуля, код ошибки.  || Расшифровку можно посмотреть в разделе  [[ПланФикс API:Коды ошибок|Коды ошибок]]
-|-
-|}
-----
+*[[Коды ошибок]]
-=== Перейти ===
+*[[ПланФикс API:Пример аутентификации на php|Пример кода на PHP]]
-[[ПланФикс API]]