Getting started with the Vasto API

The Vasto API allows your organisation to securely read selected training information from Vasto, so it can be used by another system, website, or integration. The API is designed for technical users such as web developers, IT providers, or integration partners.

A common use case is displaying current course or module offerings on your website, including direct enrolment links that send users back to Vasto to complete their enrolment.

The full technical API documentation is available here:

Vasto API documentation: https://vastosoft.com/next/docs/api

You can send this link to your web developer or technical provider.

What can the API be used for?

The Vasto API can be used to retrieve information such as:

• Courses and modules
• Scheduled timetable items
• Venues
• Trainers and assessors
• Reference data such as countries and states

The timetable information includes a ready-to-use enrolment URL, which can be placed on your website as a “Book now”, “Enrol now”, or “Register” button. This allows prospective students to browse training options on your public website and then continue the enrolment process inside Vasto.

Example use case: enrolment links on your website

Your website developer can use the API to retrieve your published timetable items from Vasto.

For each item, the API can provide details such as:

• Course or module title
• Start date
• Venue
• Available places
• Price fields
• Published status
• Direct enrolment link

Your website can then display these details in a public course list. When a visitor clicks the enrolment link, they are taken to the relevant Vasto enrolment page.

This is useful when you want your website to remain the public-facing source of course information, while Vasto continues to manage the enrolment process.

What the API does not do

The API is intended for integrations and technical access to Vasto data. It is not a replacement for the Vasto admin portal.

For admin staff, this means:

• You do not need to write code to use the API.
• Your developer or IT provider will use the API documentation.
• You are responsible for generating and managing API keys.
• API keys should only be shared with trusted technical providers.

The current documentation describes the API as read-only and scoped to your subscriber account, meaning users can only access your organisation’s data.

How to provide access to a developer

To allow a developer to connect to the Vasto API:

1. Log in to Vasto as an administrator.
2. Go to Admin → API Keys.
   
3. Create a new API key.
4. Copy the token immediately and store it securely.
5. Provide the API token and the technical documentation link to your developer.

Your API token is only displayed once when it is created. Vasto does not store a retrievable copy of the token. If the token is lost, you will need to revoke it and create a new one.

API key security

API keys should be treated like passwords.

Do not:

• Publish an API key on your website.
• Include an API key in public JavaScript.
• Store an API key in a public code repository.
• Share an API key with people who do not need access.

Your developer should store the API key securely on the server side of your website or application.

If an API key is no longer needed, or if you believe it may have been exposed, you can archive it from Admin → API Keys. Archived tokens can no longer be used.

Reviewing API activity

Each API token includes a call log showing API usage, including the endpoint called, request method, response status, and timestamp. This can help with auditing or troubleshooting integrations.

API logs are retained for 90 days.

Technical notes for developers

Developers should refer to the full API documentation for endpoint details, filters, response fields, pagination, authentication, and rate limits.

The API uses Bearer token authentication and supports paginated list responses. The documentation also includes details about filtering, date formats, rate limiting, and error responses.

Need help?

If you are an administrator and are not sure whether the API is suitable for your website or integration, contact Vasto support with a brief description of what you are trying to achieve.

For example:

We want to display our upcoming courses on our website and include enrolment links back to Vasto.

Vasto support can help confirm whether the API is the right option and advise what information your developer may need.