test template
Welcome to the API Getting Started Guide
What This API Does
The Smartylighting Streetlights API allows you to remotely manage the city lights. It provides a set of endpoints that enable developers to control streetlights, receive real-time environmental data, and enhance urban lighting management.
Why It's Useful
By using this API, you can efficiently manage streetlight operations, such as turning lights on or off and adjusting brightness levels. This not only improves energy efficiency but also enhances public safety and environmental monitoring in urban areas.
Prerequisites
- Basic understanding of Kafka messaging and how to interact with Kafka topics.
- Familiarity with JSON format for request and response payloads.
- Access to a development environment with internet connectivity.
- Credentials for SASL/SCRAM authentication (see Authentication section below).
Resources and Capabilities
| Resource | Capabilities |
|---|---|
| smartylighting.streetlights.1.0.action.{streetlightId}.turn.on | Turn a specific streetlight on |
| smartylighting.streetlights.1.0.action.{streetlightId}.turn.off | Turn a specific streetlight off |
| smartylighting.streetlights.1.0.action.{streetlightId}.dim | Dim a specific streetlight |
| smartylighting.streetlights.1.0.event.{streetlightId}.lighting.measured | Receive real-time information about environmental lighting conditions |
Authentication
To access the API, you must authenticate your requests using SASL/SCRAM credentials. This involves providing your username and password for authentication. Ensure that your credentials are kept secure and not exposed in client-side code or public repositories.
Getting Started
To begin using the API, follow these steps:
- Obtain your SASL/SCRAM credentials from your account settings.
- Set up your development environment and ensure you have the necessary dependencies installed.
- Review the API documentation to understand the available endpoints and their capabilities.
- Start making requests to the API using your preferred programming language or tool.
We hope this guide helps you get started quickly and effectively. For further assistance, please refer to our detailed API documentation or contact our support team.