This method logs the user in. It should always be the first method called as it returns a token that is needed to call the other methods.
Each method takes the token as a send-parameter and returns a new token as a return-parameter.
Send Params |
Return Params |
---|---|
•accountName - The name of the account. •emailAddress - The account owner's e-mail address. •password - The account owner's password. |
tokenOut - This is the new security token that should be used for the next Web Service call after this one. See the API Security topic for more details. |
Test
The test app is only available for requests from the local machine.
SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /api/portal.asmx HTTP/1.1 Host: app.perfectforms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.PerfectApps.com/Portal/Login"
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <Login xmlns="http://www.PerfectApps.com/Portal"> <accountName>string</accountName> <emailAddress>string</emailAddress> <password>string</password> </Login> </soap:Body> </soap:Envelope> |
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <LoginResponse xmlns="http://www.PerfectApps.com/Portal"> <LoginResult>int</LoginResult> <token>string</token> </LoginResponse> </soap:Body> </soap:Envelope> |
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /api/portal.asmx HTTP/1.1 Host: app.perfectforms.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Login xmlns="http://www.PerfectApps.com/Portal"> <accountName>string</accountName> <emailAddress>string</emailAddress> <password>string</password> </Login> </soap12:Body> </soap12:Envelope> |
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <LoginResponse xmlns="http://www.PerfectApps.com/Portal"> <LoginResult>int</LoginResult> <token>string</token> </LoginResponse> </soap12:Body> </soap12:Envelope> |
See also: PlayerLogin
Return to: PerfectApps API, Integration