The Tovuti API allows LMS administrators and software developers to create resilient and scalable integrations between Tovuti and other API-compatible applications. An integration with the Tovuti API allows any platform or application to share and receive data with Tovuti.
Endpoints are also referenced when configuring webhooks through Zapier.
The Tovuti API Documentation is publicly available at api.tovuti.io. The API is written in alignment with the OpenAPI 3.0 specification, formerly known as the Swagger Specification. This means the documentation provides access to the raw schema.yml file, which contains all API data.
Each tag and endpoint is expandable to give full details on how to call each endpoint. Review the list of endpoints for an overview of what capabilities the Tovuti API provides.
Create a Tovuti API Token
A Tovuti API Token is a text string that encodes the LMS and provides authorized endpoints and methods to anyone using the token.
For detailed information on creating an API Token, view the Help Center article here.
Review Each Endpoint
Click the expander for any category to view the specifications for all supported endpoints.
Open the /schema.yml file on the documentation page. The .yml shown is the formal OpenAPI specification of all endpoints and is used to create custom API code.
Test Endpoints with Live Data
To try out an endpoint, first, click Authorize.
Type “Bearer” followed by a space and paste the API Token into the space provided. Click Authorize.
Endpoints must be authorized by the Tovuti API Token to access the LMS and return data.
Expand an endpoint and click Try it out.
Enter the Parameters to include in the test, and click Execute.
The results of the endpoint test include the Curl Command (1), Authorization Token (2), Request URL (3), Server Response (4), and JSON response. Click Download (5) or Copy (6) to use the JSON response directly in the codebase, or in an API tool like Postman.