Authentication web servisine ait aşağıdaki metodlar bulunmaktadır.
| Method | Description |
|---|---|
| Login | Webservis isteği yapılması için öncelikle Login metodu ile SERVICE TICKET alınmalıdır. |
| Logout | Herhangi bir web servis isteği yapılmayacaksa, sistemden çıkış için LOGOUT kullanılmalıdır. |
Geliştiricinin her hangi bir web servis ile etkileşime geçebilmesi için, öncelikle Login metodunu kullanarak bir SERVICE TICKET alması gerekir. Diğer web servis ve metodlarına yaratmış olduğu bu değer ile istekte bulunabilir.
Login
<login> |
|---|
Web servis istekleri yapabilmek için, önce LOGIN olunup bir SERVICETICKET alınır. Bu SERVICETICKET, her web servis isteğinde kullanılır. |
Parameters
| Parameter | Value | |
|---|---|---|
| Username | Web service user name provided by RMC | MANDATORY |
| Password | Web service password provided by RMC | MANDATORY |
REQUEST EXAMPLE
<?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://ws.euromsg.com/auth"> <Username>string</Username> <Password>string</Password> </Login> </soap:Body> </soap:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<LoginResponse
xmlns="http://ws.euromsg.com/auth">
<LoginResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ServiceTicket>3C860EC9BFF1B14BBF801</ServiceTicket>
</LoginResult>
</LoginResponse>
</soap:Body>
</soap:Envelope>
Başarılı istek durumunda <CODE> parametresi 00 olarak cevap döner.
<SERVICETICKET> değeri, yanlızca giriş başarılı olduğu durumda döner. Bu değer saklanılmalı ve diğer web servis ve web servis metodları için istek yapılmak istenildiğinde kullanılmalıdır.
Error Parameters
| Code | Error Message | Description |
|---|---|---|
| 99 | Invalip IP | Web servis isteği gönderilen IP’nin web servis kullanıcısında tanımlı olmadığını ifade eder. |
| 99 | No such user/password! | Kullanıcı bilgileri yada login olunmaya çalışılan servis URL’i hatalı olabilir. |
Logout
| <logout> |
|---|
Web servis isteği yapılmayacaksa, LOGIN ile açılmış oturumu sonlandırır. SERVICETICKET sona erdirilir. |
Parameters
| Parameter | Value | |
|---|---|---|
| ServiceTicket | session ID you want to end | MANDATORY |
REQUEST EXAMPLE
<?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> <Logout xmlns="http://ws.euromsg.com/auth"> <ServiceTicket>ABCDEFG</ServiceTicket> </Logout> </soap:Body> </soap:Envelope>
RESPONSE EXAMPLE
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<LogoutResponse xmlns="http://ws.euromsg.com/auth">
<LogoutResult>
<Code>00</Code>
<Message />
<DetailedMessage />
</LogoutResult>
</LogoutResponse>
</soap:Body>
</soap:Envelope>
Başarılı istek durumunda <CODE> parametresi 00 olarak cevap döner.
Error Parameters
| Code | Error Message | Detailed Message | Description |
|---|---|---|---|
| 9998 | Unauthorized User! | Object reference not set to an instance of an object. | Logout failed. Invalid <ServiceTicket>. |