Audit API

Audit API

Summary

The Audit API allows you to consult audit records in detail of applications received and responses submitted from APIs methods.

Through this API you can learn the details of each of the requests made to your APIs and the responses submitted.

Access the Administrative APIs portal at https://admin.vor-tex.io/. Sign in with your Administrator credentials and you could view the Audit API specifications.


Specifications

Application

The method GET /documents allows you to search for registered audit documents. The method accepts the following parameters:

Parameter
Example value
Validations
Description
apislug
balances
Text
API name in slug format
apiversion
1
Whole number
Version of the API
date
2022-08-02
Date
Date of applications in yyyy-mm-dd format
environment
Production Production
Production, Staging, Development
Application environment
statuscode
200 200
Whole number
HTTP response codes
methodformat
json
Text
Method of implementation of the method
methodpath
balances
Text
Route to the method
auth20
false
true, false
Protection with OAuth20
requesttype
Get
Post, put, patch, delete, get, options, head, create
Type of application to the method
size
10
Whole number
Number of records to be obtained
sort
desc desc desc desc
asc, desc
Sort by date
userapplication
App
Text
Name of customer application
username
vortex
Text
Username
visibility
Public
Public, private
Visibility of the method

Asterisk * can be used as a convenience to obtain data without filters.

This is a request example:

Answer

The API response would provide the list of audit documents, as an example:
{
"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",
"methodEnvironment":"Production",
"methodVisibility":"Private"
},
"user": {
"id":99999,
"name":"vortex",
"email":"vortex@vor-tex.io",
"application":"Vor-Tex app",
"auth20":false
},
"request": {
"type":"Get",
"body": {
"auth_key":"***************************"
},
"headers": {
"sec-fetch-user":"?1",
"accept-language":"en-ES,en;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":2 0,
"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 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": {
},
"Meta": {
"total-pages":1
}
}
},
"headers": {
"vary":"Accept",
"content-length":"665",
"content-type":"application/json",
"allow":"Get, post, put, patch, delete, options"
},
"time":915,
"length":339,
"timestamp":1659445164
}
}
]
}

The answer contains:
  1. The date of the request is in the "date" attribute.
  2. API details and method are informed in the "api" object.
  3. The details of the user who made the request in the "use" object.
  4. Details of the application in the "request" object, including the type of request, parameters, body and headers of the application.
  5. The details of the answer in the object "response", including the code and the body of the answer.
  6. The response time in the "time" attribute is expressed in milliseconds.
  7. The size of the answer in the "length" attribute is expressed in bytes.


    • Related Articles

    • Administrative APIs: introduction

      Administrative APIs would allow you to check your account data. Administrative APIs you can consult: Statistics for the use of your APIs Audit queries made to your APIs and responses delivered Health of Methods (SLO) List of users of your account ...

    • Create and configure APIs

      Summary APIs would be exhibited on the developer portal. An API can contain multiple versions, and each of the minimum versions. To create an API you must go to APIs > New APIs. Configure APIs When creating a new API you should complete the Title, ...

    • Create APIs methods

      Summary In the article Create and manage APIs versions The first necessary steps to create APIs were shown. Methods define the action to be taken on a particular esource. As a first step you should select the option of Add Methodin the API. Add ...

    • Configure context variables at method parameters

      Summary Context variables allow you to associate values assigned to the account, users and applications to APIs parameters values. By setting up the API method you can relate its parameters to context variables. When a request is made to the method, ...

    • APIs catalog and documentation

      Summary Once you have accessed the developer portal with your credentials, you can access the APIs catalog and its documentation. APIs Catalogue In the APIs Catalog you could learn about available APIs and access their documentation. API ...