REST (Representational State Transfer) APIs are fundamental tools for building interactive and dynamic web applications. REST APIs allow for easy and efficient communication between computer systems over the internet by making requests and receiving responses in a standard format. They are designed to use a stateless communication protocol, typically HTTP, to perform CRUD operations (Create, Read, Update, Delete) on data.

Dawiso’s robust REST API enables developers to integrate and interact with the platform seamlessly. The API adheres to best practices in RESTful architecture, ensuring that it is both scalable and maintainable.

The Dawiso API documentation provides a complete list of available endpoints, including descriptions, required parameters, and example responses.

The version varies depending on your Dawiso instance. Simply append the following suffix to your BE API domain URL, which can be obtained:

  • From the Customer Success team
  • Identified through developer tools like in the screenshot below (Press F12 > navigate to the Network tab and refresh the page > use search to look up :authority):
{yourdomain}/swagger/index.html

For example, the correct API documentation version for the Dawiso Demo instance is here:

https://demo.dawiso.com/swagger/index.html

API versioning

The Dawiso API is versioned to facilitate enhancements and ensure backward compatibility without disrupting existing implementations.

You can identify the version of the API you are accessing through the URL structure:

  • v1 in /api/public/v1/auth/login

The latest and most up-to-date version will always be detailed in the API documentation.

Deprecated APIs

To ensure higher efficiency or security, occasionally, certain API endpoints will be deprecated. API endpoints marked as deprecated in our API documentation are expected to be decommissioned during one of the next Long Term Support (LTS) updates, meaning customers will have at least 6 months to ensure seamless transition.

Details will be provided in our release notes, which will include:

  • New replacement API endpoints.
  • Information on changes in the parameters or data structures.

We ensure that despite any updates or changes, the core functionality and crucial data accessible via existing API endpoints will remain consistent. This means that while we may introduce enhancements or additional features, the fundamental use of the API endpoints will not change to safeguard your integration processes and ensures a seamless transition when updates are made.