API Auditoría

API Auditoría

Resumen

La API Audit permite consultar los registros de auditoría con el detalle de solicitudes recibidas y respuestas entregadas de los métodos de las APIs.

Mediante esta API podrás conocer el detalle de cada una de las solicitudes realizadas a tus APIs y las respuestas entregadas.

Accede al porta de APIs Administrativas https://admin.vor-tex.io/, ingresa con tus credenciales de Administrador y podrás visualizar las especificaciones de la API Audit.


Especificaciones

Solicitud

El método GET /documents permite buscar documentos de auditoría registrados. El método acepta los siguientes parámetros:

Parámetro
Valor de ejemplo
Validaciones
Descripción
apislug
balances
Texto
Nombre de la API en formato slug
apiversion
1
Número entero
Versión de la API
date
2022-08-02
Fecha
Fecha de las solicitudes en formato yyyy-mm-dd
environment
Production
Production, Staging, Development
Entorno de ejecución de las solicitudes
statuscode
200
Número entero
Códigos HTTP de respuesta
methodformat
json
Texto
Formato de ejecución del método
methodpath
balances
Texto
Ruta al método
auth20
false
true, false
Protección con OAuth20
requesttype
GET
POST, PUT, PATCH, DELETE, GET, OPTIONS, HEAD, CREATE
Tipo de solicitud al método
size
10
Número entero
Cantidad de registros a obtener
sort
desc
asc, desc
Ordenar por fecha
userapplication
App
Texto
Nombre de la aplicación cliente
username
vortex
Texto
Nombre de usuario
visibility
PUBLIC
PUBLIC, PRIVATE
Visibilidad del método

El asterisco * puede utilizarse como comodín para obtener los datos sin aplicar filtros.

Así es una solciitud de ejemplo:

Respuesta

La respuesta de la API entregará el listado de los documentos de auditoría, a modo de ejemplo:
{
    "apiVersion": "1",
    "meta": {
        "count": 1
    },
    "data": [
        {
            "date": "2022-08-02T12:59:24.535622",
            "api": {
                "apiSlug": "balances",
                "apiVersion": 1,
                "methodId": 6774,
                "methodPath": "balances/22289",
                "methodFormat": "json",
                "methodUri": "http://api.demo.vor-tex.io/balances/v1/balances/22289.json",
                "methodEnvironment": "Production",
                "methodVisibility": "PRIVATE"
            },
            "user": {
                "id": 99999,
                "name": "vortex",
                "email": "vortex@vor-tex.io",
                "application": "App de Vor-Tex",
                "auth20": false
            },
            "request": {
                "type": "GET",
                "body": {
                    "auth_key": "***************************"
                },
                "headers": {
                    "sec-fetch-user": "?1",
                    "accept-language": "es-ES,es;q=0.8,en-US;q=0.5,en;q=0.3",
                    "accept-encoding": "gzip, deflate, br",
                    "sec-fetch-site": "none",
                    "host": "api.demo.vor-tex.io",
                    "accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8",
                    "upgrade-insecure-requests": "1",
                    "connection": "close",
                    "cookie": "_ga=GA1.2.241338126.1630418350; _ga_JQFPJ2DSQ8=GS1.1.1651241563.2.0.1651241563.0; _ga_4N5DBHDVG0=GS1.1.1659442991.25.1.1659443009.42; zps-tgr-dts=sc%3D23-expAppOnNewSession%3D%5B%5D-pc%3D2-sesst%3D1659442992500; junar7-_zldp=RG5MW57AlzJ2lk%2FDsUWtPKrPtwPynteC0lkq8K%2F125%2BZfK3DSHgC9b3GlsHLv9BdodoRkLyJC2Y%3D; vortex-_zldp=RG5MW57AlzJC1mKAoq24PTFqj2LgDwFyn%2BJgi5h5V3fS%2BzZU5o12vcCmLKWmxm8hodoRkLyJC2Y%3D; zabHMBucket=BTvtJHv; vortexsessionid=jtx86vjgrh98nuvhvr5y0yjc7fsagz8z; _gid=GA1.2.1450042233.1659290429; com_chat_owner=1659442486245; com_avcliq_owner=1659442486246; zft-sdc=isef%3Dtrue-isfr%3Dtrue-src%3Ddirect",
                    "sec-fetch-mode": "navigate",
                    "x-real-ip": "132.876.13.61",
                    "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:104.0) Gecko/20100101 Firefox/104.0",
                    "sec-fetch-dest": "document"
                },
                "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:104.0) Gecko/20100101 Firefox/104.0",
                "ip": "132.876.13.61"
            },
            "response": {
                "statusCode": 200,
                "body": {
                    "Data": {
                        "Balance": [
                            {
                                "AccountId": "22289",
                                "Amount": {
                                    "Amount": "1230.00",
                                    "Currency": "USD"
                                },
                                "CreditDebitIndicator": "Debit",
                                "Type": "InterimAvailable",
                                "DateTime": "2019-04-05T10:43:07+00:00",
                                "CreditLine": [
                                    {
                                        "Included": "TRUE",
                                        "Amount": {
                                            "Amount": "1000.00",
                                            "Currency": "USD"
                                        },
                                        "Type": "Pre-Agreed"
                                    }
                                ]
                            }
                        ],
                        "Links": {
                            "self": "https://api.demo.vor-tex.io/cuentas/v1/accounts/balances/"
                        },
                        "Meta": {
                            "total-pages": 1
                        }
                    }
                },
                "headers ": {
                    "vary": "Accept",
                    "content-length": "665",
                    "content-type": "application/json",
                    "allow": "GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS"
                },
                "time": 915,
                "length": 339,
                "timestamp": 1659445164
            }
        }
    ]
}

La respuesta contiene:
  1. La fecha de la solicitud en el atributo "date".
  2. Los detalles de la API y método consultado en el objeto "api".
  3. Los detalles del usuario que realizó la solicitud en el objeto "user".
  4. Los detalles de la solicitud en el objeto "request", incluyento el tipo de solicitud, los parámetros, cuerpo y cabeceras de la solicitud.
  5. Los detalles de la respueta en el objeto "response", incluyendo el código y el cuerpo de la respuesta.
  6. El tiempo de la respuesta en el atributo "time" expresado en milisengundos.
  7. El tamaño de la respuesta en el atributo "length" expresado en bytes.


    • Related Articles

    • APIs Administrativas: introducción

      Resumen Las APIs Administrativas le permitirán consultar datos de su cuenta. Mediante las APIs Administrativas podrá consultar: Estadísticas de uso de sus APIs Auditar las consultas realizadas a sus APIs y las respuestas entregadas Salud de los ...

    • Crear y configurar API

      Resumen Las APIs serán expuestas en el portal para desarrolladores. Una API puede contener múltiples versiones, y cada una de las versiones mútiples métodos. Para crear una API debe ir a APIs > Nueva API. Configurar API Al crear una nueva API deberá ...

    • Crear métodos de APIs

      Resumen En el articulo Crear y gestionar versiones de APIs se mostraron los primeros pasos necearios para crear APIs. Los métodos definen la acción que se realizará sobre un determinado recurso. Como primer paso debe seleccionar la opción de Agregar ...

    • Cómo crear una aplicación

      Resumen La aplicación obtiene las credenciales que le permiten identificarse al consumir las APIs. Crear una aplicación Para crear una aplicación debe estar registrado y autenticado en el portal. Una vez autenticado, haga clic en Crear aplicación. ...

    • Cómo configurar Variables de contexto

      Resumen Las variables de contexto permiten asociar valores asignados a la cuenta, usuarios y aplicaciones a valores de parámetros de los métodos de las APIs. Al configurar el método de la API puedes releacionar sus parámetros a variables de contexto. ...