API Basics

The Synapcus API suite adheres to the widely-accepted REST architectural norms, ensuring a consistent and intuitive URL design across the board. Leveraging the full spectrum of conventional HTTP capabilities, these APIs support an array of methods such as POST, GET, PUT, and DELETE, alongside utilization of standard HTTP status codes to indicate errors. In addition to these, the APIs employ specialized JSON-formatted error messages to provide more detailed insights when exceptions occur.

API requests to the Synapcus platform should be directed to the base endpoint of each customer private cloud installation, like https://customer.synapcus.com.

All responses from API calls are returned in a structured JSON format, conforming to the best practices of modern web services and promoting ease of integration and consistency in data handling for client applications.