Authenticate Credentials and Grant Access Token - Brainware Intelligent Capture - Foundation 23.1 - Foundation 23.1 - Brainware - external

Brainware API Requests

Platform
Brainware
Product
Brainware Intelligent Capture
Release
Foundation 23.1
License

POST /api/v1/Authentication

Implementation Notes

To gain access to Brainware API, the user must be authenticated. The user must be a valid user that has AEB or ADM role.

Upon successful validation of credentials, a bearer token is returned which can then be used to authenticate subsequent calls to Brainware API.

By default, a bearer token is valid for 60 minutes.

Request Endpoint

/api/v1/Authentication

Sample Curl

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'Pragma: no-cache' --header 'Cache-Control: no-cache' -d 'userName=UserName&password=Password&grant_type=password' 'http://localhost/BrainwareAPI/api/v1/Authentication'

Sample Request

POST /Authentication userName=brainware&password=brainware&grant_type=password

Parameters

Parameter Description Type Required
userName User name string Required
password Password string Required
grant_type Grant type string Required

Sample Response

{ "access_token": "fH9Km8cf36YDry5AJvgk1WfmZmor7IN4Ep8WCxzbgqDRmZ833E2sGI1aVDbXUmeNokiw3LI3ufCZOx49R-r8hNHtcQf9eT8OmD-ukVFd6_U3lr1W2T4MqdDmQ0gJZ-Csc3pR0Bf4grJJqyoWOw-PzBJmFfRMkNbNKzwMWCOX0JvUKQnK2Mz1kJeijh73CoJN9vXb_W-zc5yLsMyTdDRX4w", "token_type": "bearer", "expires_in": 3599 }

Response Codes

Code Description
200 Authentication successful, access token generated.
400 Invalid request parameters.