This page will help you get started with the Nexudus APIs
How does it work?
The Nexudus Platform is an api-first system, which means every single component has a representation in the API and can be used programmatically by a developer.
API-first?
In the Nexudus Platform, if there is no API for it, it doesn't exist!
There are two types of groups of APIs available:
- The REST API
- The Public API
The Nexudus Platform REST API is implemented as JSON over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Coworker, Checkin or Booking has its own URL and is manipulated in isolation. In other words, we’ve tried to make the API follow the REST principles as much as possible.
PATCH requests
The Nexudus API does not support PATCH requests. You must always read a full record before submiting the complete record as part of your PUT requests.
The Public API lets you implement applications that connect with the public and members areas of a Nexudus account. As opposed to the REST API, the Public API assumes you will be making non-authenticated requests or authenticated as the end-user (i.e your customers and members)
Accepted Protocols
The Nexudus Platform API only accepts connections from clients using TLS 1.2 or higher.
ERD Diagram
You can access this ERD Diagram to help you understand how the different entities relate in Nexudus.