Web service calls are authenticated by verifying that a valid authentication token is in the header of the request. Following are instructions and examples using Postman.
To obtain an authentication token, post to the authorizations endpoint.
The URL for the endpoint is https://xxx.studytrax.com/api/v1/authorizations. Change "xxx" to the prefix of the server you are targeting (e.g., "my" if target is https://my.studtrax.com).
In the body of the request, supply JSON with properties “username” and “password”
For example {username: "demoadmin", password: "pw"}
Note, it may be helpful to create a user specifically for doing API calls. The user can be flagged as a “service account”, which means the user’s password will not expire and will not need multifactor authentication even if it is required at the customer level. Moreover, the user’s permissions can be limited to the functions needed for the API calls.
If the request is successful, the response will contain JSON that has the authentication token as the "authorization" property.
To use the authentication token, add it to the header of a request with "x-authorization" as the key and the authorization token as the value.
