Implementación API
Método mostrar links
Este método permite consultar un link generado, mostrando el detalle del mismo.
Descripción (informativo)
Método para mostrar a detalle el listado de los links de pago que haya generado su usuario, si es usuario administrador puede ver todos los links generados en su empresa. Puede mostrar todos sus links o filtrarlos por un rango de fechas con los parámetros “inicio” y “fin”. Si no se colocan estos parámetros “inicio” y “fin”, traerá los últimos links creados con un máximo de 500 links.
Resultado
Devuelve un listado de links de pago con información detallada.
URL Método en producción
Parámetros de envío por POST
| Parámetro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| llave | varchar | key único para consumo web proporcionada por administrador de sistema | Sí |
| token | varchar | token creado para consumo de métodos api rest (resultado método login) | Sí |
| inicio | date | Formato YYYY-mm-dd o dd-mm-YYYY | No |
| fin | date | Formato YYYY-mm-dd o dd-mm-YYYY | No |
Parámetros de resultado JSON
| Parámetro | Tipo | Descripción |
|---|---|---|
| Result | integer | Indicar de respuesta de consumo válida. |
| message | varchar(200) | Detalle de respuesta del consumo del método |
| data | complex | Array de datos con detalle de cada link. |
Complex Data
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre_interno | varchar | nombre ingresado en el link por el pagador |
| titulo | varchar | título del link ingresado en la creación |
| codigo_interno | varchar | key o código de link creado o publicado |
| descripcion | varchar | descripción detallada del producto |
| imagen | varchar | url de la imagen cargada al link si tuviera. |
| tipo | varchar | posibles valores “API” indica que el link fue creado desde la API |
| precio | double | precio actual del link |
| ventas | integer | numero de ventas realizadas por este link |
| visita | integer | número de visitas realizada por este link |
| estado | varchar | Posibles resultados Activo, Bloqueado |
| redes_sociales | complex | array que contiene la información de las redes sociales con las que se creó el link y sus links |
Complex redes sociales
| Parámetro | Tipo | Descripción |
|---|---|---|
| nombre | varchar | nombre de red social |
| URL | varchar | url del link para cada red social |