Planfix API: Authentication: Difference between revisions
From Planfix
(Created page with "{{#seo: |title=Planfix API: Authentication |titlemode=append |keywords=planfix, Planfix API: Authentication, API |description=Planfix API: Authentication }} == Authentication...") |
No edit summary |
||
| Line 27: | Line 27: | ||
|- | |- | ||
|signature || string(32) || not required, MD5 calculated from function name and values of all fields excluding signature || for a detailed description of how to create signatures, see Planfix API: Creating digital signatures]] | |signature || string(32) || not required, MD5 calculated from function name and values of all fields excluding signature || for a detailed description of how to create signatures, see Planfix API: Creating digital signatures]] | ||
|- | |||
|} | |||
== Server response == | |||
<source lang="xml"> | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<response status="ok"> | |||
<sid></sid> | |||
</response> | |||
</source> | |||
{| class="wikitable" style="margin-top: 1em; width:100% " | |||
!width="150"|Name !!width="200"| Type !!width="50%"| Value !! Notes | |||
|- | |||
|sid || string(32) || session name after successful authentication || this value is used when executing subsequent user identification requests | |||
|- | |- | ||
|} | |} | ||
Revision as of 12:30, 30 June 2022
Authentication
User authentication in Planfix. As a result of executing this function, the user gets a secret key (session key).
<?xml version="1.0" encoding="UTF-8"?>
<request method="auth.login">
<account></account>
<login></login>
<password></password>
<signature></signature>
</request>| Name | Type | Value | Notes | |
|---|---|---|---|---|
| account | string | name of the account through which all functions will be performed | (if you log in to Planfix at https://https://name.planfix.com the account name you need to pass is in the field "name") | |
| login | string | username | this is the name the user uses to log in to Planfix. All future requests will be made from this username | |
| password | string | user password, not hidden | ||
| signature | string(32) | not required, MD5 calculated from function name and values of all fields excluding signature | for a detailed description of how to create signatures, see Planfix API: Creating digital signatures]] |
Server response
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<sid></sid>
</response>| Name | Type | Value | Notes |
|---|---|---|---|
| sid | string(32) | session name after successful authentication | this value is used when executing subsequent user identification requests |