Best Practices
Empfohlene Muster für den Aufbau robuster und leistungsstarker Integrationen mit den STEF-APIs.
Rate Limiting
Beachten Sie die vom API zurückgegebenen Rate-Limiting-Header:
| Header | Beschreibung |
|---|---|
X-RateLimit-Limit | Maximale Anzahl von Anfragen pro Fenster |
X-RateLimit-Remaining | Verbleibende Anfragen im aktuellen Fenster |
X-RateLimit-Reset | Zeitstempel für die Fenster-Zurücksetzung |
Retry-After | Sekunden zu warten (bei 429) |
Sicherheit
Geheimnisverwaltung
Verwenden Sie Umgebungsvariablen oder einen Secrets Manager:
# .env
STEF_CLIENT_ID=your_client_id
STEF_CLIENT_SECRET=your_client_secret
# .gitignore
.env
Performance
Caching
- Cachen Sie Antworten von Lese-Endpunkten, die sich nicht häufig ändern
- Beachten Sie die Header
Cache-ControlundETag - Verwenden Sie bedingte Anfragen (
If-None-Match,If-Modified-Since)
Effiziente Paginierung
- Verwenden Sie die vom API bereitgestellte cursor-basierte Paginierung
- Begrenzen Sie die Anzahl der Elemente pro Seite (
limit) auf das strikt Notwendige - Vermeiden Sie das Laden aller Seiten auf einmal
Komprimierung
Aktivieren Sie die gzip-Komprimierung in Ihren Anfragen:
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept-Encoding: gzip"
Monitoring
- Protokollieren Sie Antwortzeiten und Rückgabecodes
- Richten Sie Alarme für 4xx- und 5xx-Fehler ein
- Überwachen Sie Ihren Quotenverbrauch über das Portal-Dashboard