Preguntas Frecuentes
Uso de credenciales
Las credenciales de Conecta (Client ID y Client Secret) permiten autenticar de forma segura a un comercio frente a la API. Son necesarias para obtener un token de acceso mediante OAuth 2.0 y consumir los servicios disponibles.
No.
Por motivos de seguridad, el Client Secret se muestra una única vez al momento de la creación. Es fundamental copiarlo y almacenarlo de forma segura.
En caso de pérdida, deberá generar una nueva API Key desde el portal. No es posible recuperar un Client Secret ya creado.
Sí.
El sistema permite gestionar hasta 4 credenciales activas por usuario, lo cual puede ser útil para distintos entornos (desarrollo, testing, producción) o integraciones.
Se recomienda eliminar una credencial cuando:
-Ya no está en uso
-Ha sido comprometida
-Se desea reemplazar por una nueva
-El secreto ha expirado
El token de acceso es una credencial temporal que se obtiene utilizando el Client ID y Client Secret. Se utiliza para autenticar cada solicitud a la API sin exponer las credenciales originales.
La duración del token depende de la configuración del proveedor de autenticación (OAuth 2.0). Actualmente 1h. Una vez expirado, deberá generarse uno nuevo.
La API utiliza el flujo OAuth 2.0 Client Credentials, orientado a comunicación entre sistemas (sin intervención de usuario).
Verifique los siguientes puntos:
- Client ID y Client Secret correctos
- URL de token correctamente configurada
- Scope configurado correctamente
- Conectividad con el endpoint de autenticación
No.
Las credenciales son sensibles y deben mantenerse confidenciales. Nunca deben compartirse ni incluirse en código público.
No.
Puede reutilizar el token hasta que expire. Una vez expirado, deberá solicitar uno nuevo.
No.
Postman es solo una herramienta de prueba. La integración puede realizarse desde cualquier lenguaje o sistema que soporte solicitudes HTTP.
Paginacion y query_name
query_name es un identificador de búsqueda generado por el sistema, que representa el resultado de una consulta previa. No es un texto libre, sino una clave que permite reutilizar un conjunto de datos ya procesado por el backend.
El query_name se obtiene en la respuesta del endpoint al realizar la primera consulta.
Ejemplo:
POST /chargebacks
{
}
Respuesta:
{
"chargebacks": [...],
"total_items": 150,
"total_pages": 8,
"query_name": "abc123",
"page_number": 1
}
El valor de query_name devuelto debe ser utilizado en las siguientes requests.
Permite:
- Reutilizar el resultado de una consulta previa
- Evitar recalcular filtros en cada request
- Navegar entre páginas de forma consistente
- Mejorar el rendimiento de la API
Una vez obtenido, se debe enviar en las siguientes requests junto con el page_number.
Ejemplo:
POST /chargebacks
{
"query_name": "abc123",
"page_number": 2
}
Esto devuelve la segunda página de resultados de la misma consulta.
No es obligatorio en la primera request. Es necesario para acceder a páginas posteriores de una misma consulta
query_name mantiene el contexto de la búsqueda, mientras que page_number permite navegar entre las distintas páginas de ese resultado. Ambos parámetros trabajan en conjunto.
El parámetro page_number se utiliza para controlar la paginación de resultados en distintos endpoints de la API, como por ejemplo:
- Cupones (/cupones, /cupon)
- Liquidaciones (/liquidaciones)
- Contracargos (/chargebacks)
Dado que estas consultas pueden devolver un gran volumen de información, la API responde los datos de forma paginada.
Uso conjunto con query_name
El parámetro page_number debe ser utilizado junto con query_name.
Esto se debe a que:
- query_name identifica el conjunto de resultados de una consulta previa
- page_number permite navegar entre las páginas de ese mismo conjunto
Ambos parámetros trabajan en conjunto y no deben utilizarse de forma aislada en consultas paginadas.
Si no se especifica el parámetro page_number, la API devuelve la primera página de resultados por defecto. Esto permite obtener información inicial sin necesidad de configurar la paginación explícitamente.
Permite acceder a páginas específicas de resultados. Es la forma de avanzar en los resultados de la consulta realizada, identificada mediante el parámetro query_name.
{
"fecha_liquidacion": "AAAA-MM-DD",
"comercio": xxxxx,
"sucursal": x,
"page_number" : 5
}
- Cada página contiene solo una parte de los resultados totales
- Es necesario iterar sobre las páginas para obtener toda la información
- Al cambiar el page_number, los resultados deben variar