Skip to main content

ClassIT+ API Methods: Authenticate

Updated

The Authenticate method validates your ClassIT+ API license with NMFTA and returns a JWT response. Basic auth is used to communicate with the Authentication method. Use this JWT to access all the other API methods. The token is valid for 24 hours. For all other API calls the JWT must be included in the Authorization header as a Bearer token.

 

Header Name

 Description
Authentication Basic Base64(<clientId>:<clientSecret>)

 

Information.svg

An example Authentication method auth header:

http basic auth is base64 encoded format.
Basic Base64(<clientId>:<clientSecret>)
EX: Base64(abc:123) =>  YWJjOjEyMw==
Header
Authentication: Basic YWJjOjEyMw==

 

Method Definition

Http Method: POST

Basic Authentication: client Id and password sent in the Authorization header

URL: <Environment URL>/api/v1.0/authentication/authenticate 

Parameter Name Description Data Type
client Id / username The client Id provided on your profile page.
  • String
client secret /password The client Id provided on your profile page.
  • String

 

Method Result

Authentication Method JSON Result

Result Status Result JSON String
Success

{
    "access_token": "aaaaaaaa”,
    "token_type": "Bearer",
    "expires_in": 86400,
    "success": true,
    "message ": null
}
Failure

{
   "access_token": null,
   "token_type": null,
   "expires_in": 0,
   "success": false,
   "message ": "Authentication failed: The provided credentials are invalid. Please verify your Member ID, API key, and password, and try again."
}

 

Authentication Method Result Definition

JSON Properties Description Data Type
access_token

Encrypted token key. Pass this security token as the first parameter when requesting any SCAC web methods.

NOTE: Token keys expire after 24 hours. (See TokenExpiration).
  • String
  • JWT
token_type Authentication type is Bearer.
  • String
  • Valid Values
    - Bearer
expires_in Token expiration time is set to 24 hours from the time of authenticate.
  • DateTime
success Identifies if the method call completed successfully.
  • Boolean
  • Valid Values:
    - True
    - False
message Result message.
  • String

 

Related articles