Login: The Login method logs the API into the system using a security token.
REQUEST ATTRIBUTES
emailAddress |
string |
The email address that you use to log in to the PerfectApps system |
|---|---|---|
password |
string |
The password that you use to log in to the PerfectApps system using the email above |
securityKey |
string |
The API security key that was sent by email during the API User Access process. See Setting Up API User Access |
RETURN ATTRIBUTES
firstName |
string |
|
|---|---|---|
lastName |
string |
|
LoginResult |
int |
An integer result indicating success (= 0) or an error (<> 0) |
maxAttachmentsSize |
long |
Maximum allowable attachment file size for this user |
tokenOut |
string |
This is the new security token that should be used for the next function call after this one. See the API Security topic for more details |
REST
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
POST /REST/api/portal/Login HTTP/1.1 Host: <server url> Content-Type: multipart/form-data
Content-Disposition: form-data; name="emailAddress" string Content-Disposition: form-data; name="password" string Content-Disposition: form-data; name="securityKey" string |
HTTP/1.1 200 OK Content-Length: length Content-Type: application/json; charset=utf-8 { "firstName":string, "lastName":string, "LoginResult":int, "maxAttachmentsSize":long, "tokenOut":string } |
Return to: Account API Methods (REST), Integration
