🚀 Getting Started with the Monitoring API

Welcome to the Monitoring API! This guide will walk you through everything you need to know to begin integrating and using the API effectively—whether you're looking to monitor gateways, charging stations, power meters, or batteries in your system.

🔐 Authentication

Before accessing any endpoints, you need to authenticate your requests.

Required Authentication Methods

• API Key Auth: Add your API key in the "x-api-key" header.

x-api-key: your_api_key

• OAuth2 Client Credentials flow

🗺️ API Base URL

All requests are made to:

https://fec-rad.gitlab.io/cloud/backend-projects/apischemas/monitoring-api

📡 Monitoring Resources

1. Gateways

• List all gateways
  GET /gateways

Sample Response:

[
  {
    "name": "Gateway 1",
    "id": "gw-001",
    "status": "Online",
    "statusTimestamp": 1617181723,
    "chargingStations": []
  }
]

2. Charging Stations

• List charging stations under a gateway
  GET /gateways/{gatewayId}/chargingStations

3. Power Meters

• List power meters under a gateway
  GET /gateways/{gatewayId}/powerMeters

4. Batteries

• List batteries under a gateway
  GET /gateways/{gatewayId}/batteries

🌐 CORS Support

All endpoints support OPTIONS requests for CORS preflight. This makes the API frontend-friendly when integrated into web applications.

🛠️ Tools for Integration

Download the OpenAPI specification directly from the documentation page to import into:

• Postman
• Swagger UI
• Any OpenAPI-compatible tool

📞 Need Help?

If you're unsure about authentication, response structures, or encounter any issues while integrating, reach out to your API support contact or consult the full API documentation.