Enrolment
This describes the enrolment resource and workflow in the Provet Connect API.
Operations
Initiate Enrolment
Initiate the enrolment process to obtain an API authentication token.
GET /enrol
| Parameter | Type | Required | Description |
|---|---|---|---|
| Callback | String | False |
The Callback URL to be invoked once a user has created an API key The Callback URL will have the following parameters:
UserAuth: User-Auth API token |
| Redirect | Boolean | False | If a callback is set, redirect to this URL once the user has created an API key from within Provet Connect |
Response
Returns an Enrolment resource.
| Name | Type | Description |
|---|---|---|
| EnrolmentRequestId | String | A randomly generated GUID to identify the enrolment request |
| EnrolmentURL | String | The URL to the enrolment page in Provet Connect |
| CallbackUrl | String | The callback URL that will be invoked (if set) |
*The VPMS should then launch the Enrolment URL and poll the enrol action passing the EnrolmentRequestId if no Callback is supplied.
* For the CallbackUrl to be invoked successfully, the user must sign in to Provet Connect and create a User Token through the returned EnrolmentURL. Failure to follow this step will not invoke the CallbackUrl.
Get Enrolment Token
Get the User-Auth Token from Provet Connect.
GET /enrol/{EnrolmentRequestId}
Response
Returns a String containing the security token for the user
| Name | Type | Description |
|---|---|---|
| User-Auth | String | The User Access Token for the user accessing the API |
* If the enrolment is not complete by the user then a 408 response will be returned.