API Documentation
Introduction
Welcome to the Assentir API documentation
The Assentir API provides developers with a robust interface for integrating the platform’s features directly into their applications, allowing for seamless automation, and enhanced workflows.
Assentir Endpoints
View the OpenAPI specification file
Key Features
- RESTful Architecture: Standardised and predictable API behaviour.
- JSON Format: All API requests and responses use JSON, making it easy to integrate with modern applications.
- Authentication: Secure API authentication using token-based methods.
- Pagination & Filtering: Flexible filtering and pagination options to retrieve large data sets efficiently.
- Error Handling: Consistent and detailed error messages to support smooth debugging and development. Use Cases
Getting Started
To start using the Assentir API:
-
Create an API Key: You will need an API key, which can be generated in the settings section of your Assentir account. Keep this key secure, as it authenticates all requests.
-
Base URL: All API requests are made to the following base URL:
- Authentication: Include the API key in the header of all requests for authentication: