ACE360 Connect Documentation

Appearance

On this page

Getting Started ​

Prerequisites ​

To use ACE360 Connect, ensure that your organisation meets the prerequisites.

Create an API token ​

Once Connect has been enabled for your organisation, all you need to do is create an API token and start making requests.

Visit the ACE360 Connect Dashboard and log in with your existing ACE360 credentials. Navigate to the "Tokens" page and create an API token.

WARNING

Keep your API tokens secret. Anybody with one of your tokens can make requests on your behalf so never share them with anyone.

Example request ​

Use your API token in the Authorization header to authenticate your requests.

This example request will fetch apprentices that are associated with your organisation.

Request:

bash
curl --request GET \
  --url 'https://api.ace360connect.org/connect-api/beta/apprentices?page=1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer your-api-token'

Response:

json
{
	"total": 2,
	"currentPage": 1,
	"perPage": 10,
	"totalPages": 1,
	"data": [
		{
			"id": 249,
			"firstName": "Arthur",
			"lastName": "Patel",
			"dateOfBirth": "2016-10-20",
			"standardId": 204,
			"status": {
				"id": 3,
				"text": "Gateway Evidence Complete"
			},
			"estimatedStartDate": "2023-10-23",
			"estimatedEndDate": "2028-01-29",
			"esfaCertificateClaimedAt": null,
			"createdAt": "2023-10-23 07:08:38",
			"archivedAt": null
		},
		{
			"id": 248,
			"firstName": "Bruce",
			"lastName": "Palmer",
			"dateOfBirth": "1982-06-27",
			"standardId": 316,
			"status": {
				"id": 2,
				"text": "Gateway in Progress"
			},
			"estimatedStartDate": "2023-10-23",
			"estimatedEndDate": "2025-04-06",
			"esfaCertificateClaimedAt": null,
			"createdAt": "2023-10-23 07:08:38",
			"archivedAt": null
		},
	]
}

Available API endpoints ​

Take a look at the API Spec to see a full list of the API endpoints that are available.

WARNING

Be careful when using different API endpoints. GET requests are used to fetch data, but other types of endpoints (e.g. POST, UPDATE, DELETE, etc) will create, update, or remove data. These actions are often irreversible. If in doubt, contact ACE360 support or consult your web development team.