Overview
Authentication methods are used to log in and out. Login is mandatory because other API methods require the access token that is returned by AuthenticationLogin. Logout is optional, although recommended, because access token automatically elapses 30 minutes after last usage with MailUpService API.
AuthenticationLogin
This method returns access token that has to be used with further method calls
...
| Parameter | Description | Example |
|---|
| Username | API username (fixed name: 'a' + consoleId) or console username. Use console username if you want to create filters | a1234 |
| Password | Password for specified user | |
| IdConsole | Number that identifies console ID | 1234 |
...
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP request |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:iaut="http://Mailup.WS/IAuthenticationService">
<soapenv:Header/>
<soapenv:Body>
<iaut:AuthenticationLogin>
<iaut:request>
<iaut:Username>a1234</iaut:Username>
<iaut:Password>cbdwex4</iaut:Password>
<iaut:IdConsole>1234</iaut:IdConsole>
</iaut:request>
</iaut:AuthenticationLogin>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP response |
|---|
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<AuthenticationLoginResponse xmlns="http://Mailup.WS/IAuthenticationService">
<AuthenticationLoginResult>
<AuthenticationLoginResult>
<Token>g9s2gNlB2oIxCVM7wTHmA8rkV7JAAKtmIVVMvUDY/CnYuEMZvWyUZNGgxVaoBr1YU3MBbENC/9xk=</Token>
</AuthenticationLoginResult>
</AuthenticationLoginResponse>
</s:Body>
</s:Envelope> |
AuthenticationLogout
...
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP request |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:iaut="http://Mailup.WS/IAuthenticationService">
<soapenv:Header/>
<soapenv:Body>
<iaut:AuthenticationLogout>
<iaut:request>
<iaut:Token>g9s2gNlB2oIxCVM7wTHmA8rkV7JAAKtmIVVMvUDY/CnYuEMZvWyUZNGgxVaoBr1YU3MBb=</iaut:Token>
</iaut:request>
</iaut:AuthenticationLogout>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP response |
|---|
|
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<AuthenticationLogoutResponse xmlns="http://Mailup.WS/IAuthenticationService">
<AuthenticationLogoutResult/>
</AuthenticationLogoutResponse>
</s:Body>
</s:Envelope> |