General API Usage Information

The following pages will help you use and authenticate to the CAM API’s as well as provision using them.

1 Steps
2 Authorizing an API Session
- 2.1 Query Parameters
- 2.2 Header Parameters
- 2.3 Responses and Codes
- 2.4 Examples and Code
  - 2.4.1 C# Code
  - 2.4.2 Node js Code
- 2.5 Error Response Examples

The CAM API provides authorized HTTP client access to CAM for managing and configuring an external system, and the basic user sessions required to access and customize the service. The CAM API additionally allows you to access the modules for authentication.

Steps

Authorize the API Session
Use the Refresh API as necessary to get refreshed tokens
Connect and Provision within CAM with the relevant APIs. Refer to the Customer Center for specific API documentation as this is not publically available without a login. https://support.litera.com/s/

Authorizing an API Session

The CAM API provides a session-related client service that manages the internal service authentication and authorization and access to the session resources.
Session API calls are for internal services and applications using the CAM domain
A token is required for using this against other API’s endpoints.
The token parameter authenticates internal services and applications and does not authorize end-user sessions.
The token is produced by accessing the login endpoints for the session API
Run a POST/session/login
- A POST call to the /session/login endpoint logs in to CAM using a domain, username, and password.
- Multiple simultaneous sessions using the same credential are supported but will have the same token.
- Each token has a configurable expiry parameter, determining when to close sessions that are not processing requests.

Query Parameters

Parameter Name	Description

Parameter Name

Description

username

The user name for login

password

The password for login

domain

The session domain for login authentication

For example, mytenant.prosperowaredev.io

Note: The supported domain is CAM (https://api.{domain}/v1/cdu/auth)

Header Parameters

Header	Value	Description

Header	Value	Description
accept	application/json,text/plain	The response data type Note: If no data type value is specified, the default data type is JSON.
content-type	application/x-www-form-urlencoded	The type of data form encoding

Responses and Codes

Code	Description

Code	Description
200	OK: Entity query executed successfully and authenticated
400	User not found: The user used is not found in the system
401	Unauthorized: Authentication has failed due to an Invalid/expired token
404	Not Found: Requested entity data could not be found
502	Internal server error: The server ran into an error when processing the post

Examples and Code

Replace the username, password, and domain for your instance as necessary.

You can also authenticate end-user sessions using a Keycloak access token created as the following:

{
"accessToken": "*******************************************************",
"refreshToken": "*************************************************************************",
"accessTokenExpiry": "2021-05-26T11:32:16.000Z"
}

C# Code

var client = new RestClient("https://api.prosperowaredev.io/v1/cdu/auth");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("username", "dev@prosperoware.com");
request.AddParameter("password", "*********");
request.AddParameter("domain", "dev.prosperowaredev.io");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Node js Code

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://api.prosperowaredev.io/v1/cdu/auth',
  'headers': {
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  form: {
    'username': 'dev@prosperoware.com',
    'password': '*********',
    'domain': 'dev.prosperowaredev.io'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Error Response Examples

{
    "message": "User does not exist.",
    "code": "UserNotFoundException",
    "time": "2021-05-26T10:31:18.002Z",
    "requestId": "8e5b4e18-d8be-4d55-9c5c-767dc470d7b3",
    "statusCode": 400,
    "retryable": false,
    "retryDelay": 25.17876454174428
}

{
    "message": "Internal server Error",
    "code": "",
    "time": "2021-05-26T10:31:18.002Z",
    "requestId": "8e5b4e18-d8be-4d55-9c5c-767dc470d7b3",
    "statusCode": 502,
    "retryable": false,
    "retryDelay": 25.17876454174428
}