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