JSON API Server

This is the consolidated USIC JSON API server. It provides a wide range of APIs to access numerous data sources for use in USIC applications.

This API conforms to the JSON:API specification and utilizes a JWT bearer token for authentication. The bearer token can be obtained by invoking the /auth endpoint with a valid USIC username and password.

A sample curl command to obtain the bearer token is:

  curl --location 'https://jsonapi.usicllc.com/auth' \
       --header 'Accept: application/json' \
       --header 'Content-Type: application/json' \
       --data '{ "username": "[add username here]", "password": "[add password here]" }' \						
       --compressed
		

The current OpenAPI Schema for the API can be obtained by invoking the /generateRestApi endpoint. This endpoint does require a valid JWT bearer token to be passed in the Authorization header.

A sample curl command to obtain the Open API schema is:

  curl --location 'https://jsonapi.usicllc.com/generateRestApi' \
       --header 'Accept: application/json' \
       --header 'Authorization: Bearer [add JWT token here]' \
       --compressed
		 

Be aware that the actual JSON:API endpoints defined in the schema require these headers for proper usage:

       --header 'Authorization: Bearer [add JWT token here]'
       --header 'Accept: application/vnd.api+json'
       --header 'Crnk-Compact: true'
		

You can also view the lastest version of the OpenAPI schema using a selection of viewers.

• Elements
• OpenAPI-Explorer
• RapiDoc (recommended)