a. API Security v5

All WebServices are REST

Always use https for tls security the Server supports http2 by default.

Any other WebService than the one on this page must have the Authorization Header in order to work.

There are 2 ways to get Access to the APIKey of the Server to be able to use the API.

1)

Info

The API Key is given by Integra CCS when asked for an integration.

If Required we can deactivate the security.

Then use the APIKey in the Header Authorization Basic with the correspondent credentials , is important to do everything under https so we don't expose the API Key.

AJAX Example

$.ajaxSetup({
  headers: {
    'Authorization': "Basic " + APIKey
  }
});

2)

Using Credentials of a User or an Agent (this path does not require the Authorization Header so you can get the API Key).

User

^{Relative URL: Integra/resources/auth/UserLogin}

^{Method: POST
content-type:application/x-www-form-urlencoded; charset=UTF-8
Params: user
password (encrypted password)}

^{Result: JSON}

^{Where Md5secret is the APIKey}

^{If error Response is 0}