Getting started
This documentation is for developers who want to use the Sunbreak APIs. There are 2 separate APIs:
- REST - standard method of creating data tables, pick lists, etc.
- Sockets – better for real time updates, perfect for Gutenberg blocks.
The documentation here explores all of the methods and end points available, and includes code snippets for:
- JavaScript
- NODEJS
- PHP
Endpoints
The API is accessed by making HTTPS requests to a specific version endpoint URL, in which GET, POST, PUT, PATCH, and DELETE methods dictate how your interact with the information available. Every endpoint is accessed only via the SSL-enabled HTTPS (port 443) protocol.
Everything (methods, parameters, etc.) is fixed to a version number, and every call must contain one. The latest version is Version 1.
The stable base URL for all Version 1 HTTPS endpoints is:
https://api.sunbreak.io/{client}/v1/
Requests
Requests must be sent over HTTPS with any payload formatted in JSON. Depending on if a request is authenticated with the new API Tokens or the old API Keys, required headers differ and are detailed below.
Responses
Format
Each response is a JSON object. The data requested is wrapped in the tag. If you have a response, it will always be within the field. We also include a flag, an array of potential , and in the response. Some responses can have additional pagination info wrapped in the
An error object will contain an integer field and a
Date fields will always be in UTC ISO-8601 format, including microseconds.
Resource Ids
id: 1