Buenas prácticas
Patrones recomendados para construir integraciones robustas y eficientes con las APIs de STEF.
Limitación de velocidad
Respete los encabezados de limitación de velocidad devueltos por la API:
| Encabezado | Descripción |
|---|---|
X-RateLimit-Limit | Número máximo de solicitudes por ventana |
X-RateLimit-Remaining | Solicitudes restantes en la ventana actual |
X-RateLimit-Reset | Marca de tiempo de restablecimiento de la ventana |
Retry-After | Segundos a esperar (en caso de 429) |
Seguridad
Almacenamiento de secretos
Utilice variables de entorno o un gestor de secretos:
# .env
STEF_CLIENT_ID=your_client_id
STEF_CLIENT_SECRET=your_client_secret
# .gitignore
.env
Rendimiento
Caché
- Almacene en caché las respuestas de los endpoints de lectura que no cambian frecuentemente
- Respete los encabezados
Cache-ControlyETag - Utilice solicitudes condicionales (
If-None-Match,If-Modified-Since)
Paginación eficiente
- Utilice la paginación por cursor proporcionada por la API
- Limite el número de elementos por página (
limit) al mínimo estrictamente necesario - Evite cargar todas las páginas de una sola vez
Compresión
Active la compresión gzip en sus solicitudes:
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept-Encoding: gzip"
Monitorización
- Registre los tiempos de respuesta y los códigos de retorno
- Configure alertas sobre errores 4xx y 5xx
- Supervise su consumo de cuotas a través del panel del portal