Authentication API

OmniVista Cirrus Service offers an API to authenticate your application:

CODE

POST https://{your_region}.manage.ovcirrus.com/api/ov/v1/applications/authenticate

The request body is a JSON object that should contains the following information:

email: The user login email
password: The user password
appId: The application Id
appSecret: The application secret

You can try to authenticate your application using the following Curl Snippet. Simply add your user and application credentials before making the request.

CODE

curl \
  "https://{your_region}.manage.ovcirrus.com/api/ov/v1/applications/authenticate"
  -X "POST" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d $'{"email": "YOUR_EMAIL", "password": "YOUR_PASSWORD", "appId": "APP_ID", "appSecret": "APP_SECRET"}'

If your request is successful, you will get a 200 OK HTTP Response with a JSON body containing the following keys:

access_token: The generated token that must be used in the next requests.
expires_in: The number of seconds during which the token is valid. (15 days by default)
token_type: The type of token generated. Always Bearer in our platform.

CODE

HTTP Response: 200 OK

{
  "access_token": "eyJhbGciOiJIU...plaVi7K04EqcjnkhPE8",
  "expires_in": 1296000,
  "token_type": "Bearer"
}