Rest API
- 26 May 2023
- Contributors
- Print
- DarkLight
- PDF
Rest API
- Updated On 26 May 2023
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Rest API
The most common API is the rest API.
Visit documentation for endpoint definition tools and OpenAPI specs
What is Rest API
A REST API (also known as RESTful API) is an application programming interface (API or web API) that conforms to the constraints of REST architectural style and allows for interaction with RESTful web services. An API is a set of definitions and protocols for building and integrating application software.
Name: Name of the integration.
Access Type: Choose "Read" or "Read+Write". You only need "Read+Write" if you need to add sensors or gateways via the API.
System: Choose the system the Rest API shall apply to.
Rest API documentation: Link to the Rest API documentation.
Cancel: Cancel the creation of the Rest API for this system.
Save: Save and create the integration to this system.
API key
An API key will be generated when you save the integration and the API documentation is dynamic and will use your input in the API examples.
Refresh
You might have to refresh to view your new integration in the integration page.
Click your newly created integration to access the API key, view the API documentation or edit your integration.
API key
Click "Show" to view your API key or just click the blured area to copy your key to the clipboard.
Data format
Check out documentation for more information about data format for each response