Fidely API Publica
API Publica de Fidely para integradores externos. Permite gestionar clientes, transacciones, canjes, catalogo y giftcards.
Autenticacion
Todos los endpoints requieren autenticacion mediante Client ID y Client Secret en los headers HTTP:
X-Client-Id: tu-client-id
X-Client-Secret: tu-client-secret
Las credenciales se generan desde el backoffice de Fidely en Configuracion > API Clients.
Scopes
Cada API Client puede tener permisos granulares (scopes) que limitan las operaciones disponibles:
| Scope | Descripcion |
|---|---|
clients:read | Consultar clientes, beneficios, tipos de cliente |
clients:write | Crear clientes |
transactions:read | Consultar historial de transacciones |
transactions:write | Crear transacciones (sumar puntos) |
swap:write | Canjear puntos / cash / stamps |
catalog:read | Consultar catalogo de productos |
giftcards:read | Consultar saldo de giftcards |
giftcards:write | Cargar / descontar saldo de giftcards |
* | Acceso total |
Rate Limiting
Cada API Client tiene un limite de 60 requests por minuto (default). Si se excede, la API responde 429 Too Many Requests.
Auditoria
Todas las operaciones quedan registradas con el client_id, IP de origen, timestamp y duracion del request.
Authentication
- API Key: apiClientAuth
- API Key: apiClientSecret
Client ID del API Client
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Client-Id |
Client Secret del API Client
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Client-Secret |