Best practices
Aanbevolen patronen voor het bouwen van robuuste en performante integraties met de STEF API's.
Rate limiting
Respecteer de rate limiting headers die door de API worden geretourneerd:
| Header | Beschrijving |
|---|---|
X-RateLimit-Limit | Maximum aantal verzoeken per venster |
X-RateLimit-Remaining | Resterende verzoeken in het huidige venster |
X-RateLimit-Reset | Tijdstempel van vensterreset |
Retry-After | Seconden te wachten (bij 429) |
Beveiliging
Opslag van geheimen
Gebruik omgevingsvariabelen of een secrets manager:
# .env
STEF_CLIENT_ID=your_client_id
STEF_CLIENT_SECRET=your_client_secret
# .gitignore
.env
Prestaties
Caching
- Sla antwoorden op van leesendpoints die niet vaak veranderen
- Respecteer de headers
Cache-ControlenETag - Gebruik voorwaardelijke verzoeken (
If-None-Match,If-Modified-Since)
Efficiënte paginering
- Gebruik de cursorgebaseerde paginering die door de API wordt geboden
- Beperk het aantal items per pagina (
limit) tot het strikt noodzakelijke - Vermijd het laden van alle pagina's in één keer
Compressie
Schakel gzip-compressie in uw verzoeken in:
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept-Encoding: gzip"
Monitoring
- Log reactietijden en retourcodes
- Stel waarschuwingen in voor 4xx- en 5xx-fouten
- Monitor uw quotumverbruik via het portaaldashboard