CONTACTLINE v3 - Gestão Centralizada

18 de Abril de 2013

Manual - Utilização da WEB API

1 Introduction

This API is based on the REST architecture, allowing the remote use of the Terminal functions whilst being platform independent.

2 Responses

The services always respond with XML tags in the following format. The root tag is <response>. 
<?xml version="1.0" encoding="UTF-8" ?> 
<response>

<success>FALSE</success> <message>Argument missing</message> <urls>

<logout>http://.../Contactline/api/endpoint.php?method=user.logout</logout> <assignServiceDesk>http://.../Contactline/api/endpoint.php?method=user.assignServiceDesk</assignServiceDesk>

<getAvailableServiceDesks>http://.../Contactline/api/endpoint.php?method=user.getAvailableServiceDesks</getAvailableServic eDesks>

</urls> </response>

Response tag returns the method response <success> returns FALSE when errors are found. <message> gives feedback about the response

Urls tag links some usefull methods related to the current one. <method name> url of the method

3 Request headers

After the authentication, it is required the header "X-Mobbit-Contactline" which contains the session id in order to track the current session.

It should be included in every request header except in the login.

4 Methods

4.1 user.login

Allows an external user to authenticate himself in the system. Required for the use of the API methods.

Request method:

/Contactline/api/endpoint.php?method=user.login

Request parameters:

username (User username) password (User Password)

Escrito por: Miguel Teixeira

Gestão de Projecto: Luís Palma

Versão 1.0

Página:

5 / 23

Assunto: Contactline v 3.0 WEB API