Dieser Leitfaden bietet einen Überblick über die Measurabl API, how to get started, and key information you need to successfully integrate with our platform.
Herausforderungen in der Measurabl API?
Das Measurabl API allows customers and partners to programmatically interact with the Measurabl platform. This enables you to:
-
- Daten abrufen von Ihrem Measurabl account (buildings, meters, readings, etc.)
-
- Create and update data in Ihrem Measurabl Konto
-
- Workflows automatisieren zwischen Measurabl und andere Systeme
-
- Erstellen Sie benutzerdefinierte Integrationen die sich erstrecken Measurabl’s functionality
Wer kann die Measurabl API?
Das Measurabl API is now available to all Measurabl customers. Access is managed as follows:
-
- Alle Measurabl Kunden can request API access for their account
-
- Partners and vendors can access the API when authorized by a Measurabl Kunde
-
- Consultants and developers can integrate with the API on behalf of a customer
The customer always maintains control over who can access their data. Customers must explicitly authorize any third-party access to their Measurabl data through the API.
Getting Started in 5 Steps
1. Request API Access
Bitte kontaktieren Sie Ihr Measurabl representative to request API access for your account. We’ll create API credentials (key and secret) for your organization.
2. Überprüfen Sie die Dokumentation
Machen Sie sich vertraut mit:
Measurabl API-Dokumentation – Technical reference
3. Authentifizieren
All API requests require authentication. You’ll use your API key and secret to get an authentication token that’s valid for 24 hours.
POST /api/v0/auth/login
{
"email": "your-api-key",
"password": "your-api-secret"
}
4. Make Your First Request
Start by retrieving your portfolios:
GET /core/v0/portfolios
5. Build Your Integration
Based on your use case, start building your integration:
-
- Für Datenextraktion: Use GET endpoints to retrieve information
-
- Für Datenerstellung: Use POST endpoints to create new records
-
- Für Datenaktualisierungen: Use PATCH endpoints to modify existing records
Häufige Anwendungsfälle
Retrieving Building Data
Regularly pull building information for your internal systems:
GET /core/v0/portfolios/{portfolio_id}/buildings
Adding Meter Readings
Automatically upload utility data from third-party sources:
POST /core/v0/portfolios/{portfolio_id}/buildings/{building_id}/meters/{meter_id}/readings
Creating New Buildings
Add new properties to your Measurabl Portfolio:
POST /core/v0/portfolios/{portfolio_id}/buildings
Technische Daten
API-Design
-
- RESTful web service following the JSON:API specification
-
- HTTPS endpoints for secure communication
-
- JSON formatted request and response bodies
Ratenbegrenzungen
Das Measurabl API implements rate limiting to ensure system stability:
| Anfragetyp | Requests Allowed | Zeitrahmen |
| GET-Anfragen | 1000 | 5 Мinuten |
| Standard POST/PATCH/DELETE | 100 | 5 Мinuten |
| High-frequency endpoints* | 500 | 5 Мinuten |
| Authentifizierung | 25 | 5 Мinuten |
*High-frequency endpoints include meter readings and waste meter readings
Daten filtern
The API supports RSQL for filtering data:
GET /core/v0/portfolios/{portfolio_id}/buildings?filter=size=gt=10000;city==Chicago
Hilfe benötigt?
Für Unterstützung bei der Measurabl API:
- Überprüfen Sie unsere Hilfecenter
- Bitte kontaktieren Sie Ihr Measurabl Vertreter
- Email Unterstützung@measurabl.com €XNUMX