Planfix API: Authentication
From Planfix
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://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 |