AutoAPI es una herramienta innovadora que facilita la comunicación entre tablas de base de datos y modelos de KnowGraphs en el lado del cliente. Permite una visualización y presentación eficiente y personalizada de la información en la pantalla mediante la comunicación automática entre tablas y modelos de cubo. Esto significa que no necesita realizar consultas complejas o manipulaciones manuales de datos.

Cómo utilizar

Paso 1 Vaya a la pantalla para crear el AutoAPI.


Paso 2 Cree la AutoAPI.


Paso 3 Agregue la información necesaria para su AutoAPI y seleccione un método (Endpoint)


paso 4 Selecciona tu autoAPI para acceder a las configuraciones


paso 5 Entra configuración en el caso de hacer una autoAPI de tipo GET

  • selecciona entre una o mas tablas o un cubo (KUBE) para proveer y actualizar la información
  • selecciona tus columnas a compartir en tu autoAPI


paso 6 guarda los cambios para poder utilizar tu autoAPI!


entra en configuración en el caso de hacer una autoAPI de tipo POST estos son los pasos a seguir :

  • una vez hecha la primera carga de tipo POST , se habilitaran los eventos
  • estos eventos se encargan de modelar la información a medida de tu petición POST
  • luego de seleccionar tu evento podrás utilizar entre dos modelos de carga (Single / Multiple Rows) dependiendo de la necesidad del usuario , el (Single) podrás cargar datos individualmente y el (Multiple Rows) podrá cargar datos multiples de manera masiva de manera optimizada gracias a la AutoAPI
  • luego selecciona que propiedad va ser añadida en las columnas de tu tabla
  • Guarda tus cambios.


Endpoint

GET se usa para recuperar datos de una tabla o cubo (Kube). Cuando realiza una solicitud GET, le está pidiendo al servidor que devuelva un recurso o información específica, ya sea de forma individual o masiva.

GET URL

La URL se divide en tres partes:

BASE: Es la parte principal de la URL que indica la dirección base del servidor al que se realizará la solicitud.
<https://auto-api.arpia.com>

TOKEN: Es un parámetro en la URL que representa un token de acceso único y se utiliza para autenticar y autorizar la solicitud.
?token=65c6dac0e7-f9eeffc386

SHARED TOKEN: Es otro parámetro en la URL que representa un token compartido, el cual puede ser utilizado para compartir acceso o realizar ciertas acciones específicas.
&shared_token=1a46488e82eaddio219430742e6246a9562b2a7c

AUTOAPI: url y parametros unificados :
<https://auto-api.arpia.com?token=65c6dac0e7-f9eeffc386&shared_token=1a46488e82eaddio219430742e6246a9562b2a7c>

Consultas GET URL

CampoDescripciónValor PredefinidoRequerido
tokenToken de autorización creado desde Seguridad / Api Tokens.X
shared_tokenToken del recurso Kube ya sea Reportes o Tablas de Kube Store.X
resultsCantidad de registros a obtenerVacío equivale a 100.
groupbyagrupa por uno o mas campos en columnasVacio sin agrupamiento
pagePágina que desea obtener según los resultados solicitados, por ejemplo en un results=100 page=2 mostrará desde el 100 hasta el registro 200Vacío equivale 1.
filtersArray JSON con los filtros que se desea aplicar en el caso del modelo Payload o Array de variables URL GET en el caso de integración directaVacío sin filtros.
orderbyArray JSON con objeto del campo a ordenar de manera ascendente y descendente , por ejemplo
{ "field": "ID", "type": "ASC" }
Vacío sin ordenamiento y solo se aceptan campos validos y ordenamiento de tipo ASC o DESC.
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://auto-api.arpia.com?token=<Your Api Token>&shared_token=<Your Shared Token>',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "results": 100,
    "groupby": {
        "cols": [
            "IdProducto",
            "NombreProducto"
        ]
    },
    "orderby": [
        {
            "field": "NombreProducto",
            "type": "ASC"
        }
    ],
    "filters": [
        {
            "field": "IdCliente",
            "type": "=",
            "value": "C0088"
        }
    ],
    "report_type": "groupby"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer 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',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

$.get('https://auto-api.arpia.com?token=<Your Api Token>&shared_token=<Your Shared Token>', {
  results: 100,
  groupby: {
    cols: ['IdProducto', 'NombreProducto']
  },
  orderby: [
    {
      field: 'NombreProducto',
      type: 'ASC'
    }
  ],
  filters: [
    {
      field: 'IdCliente',
      type: '=',
      value: 'C0088'
    }
  ],
  report_type: 'groupby'
})
.done(function(response) {
  console.log(response);
})
.fail(function(xhr, status, error) {
  console.log('Error:', error);
});
{
   /* respuesta de servidor */
  "result": "OK",
  "data": [
    {
      "NombreCliente": "usuario 1",
      "IdCliente": "C0548",
      "IdProducto": "PS0000020",
      "NombreProducto": "NESPRESSO CATUAI 10 CAPSULAS ",
      "Item_Number": "8055732940904",
      "Count": "1"
    },
    {
      "NombreCliente": "usuario 1",
      "IdCliente": "C0548",
      "IdProducto": "PS0000021",
      "NombreProducto": "COFFEE HAT MOLIDO 250G 100% jmj",
      "Item_Number": "8050508250349",
      "Count": "1"
    },
    {
      "NombreCliente": "usuario 1",
      "IdCliente": "C0548",
      "IdProducto": "PS0000109",
      "NombreProducto": "CONFETTI ALMENDRA FONDENTE 285 GRAMOS",
      "Item_Number": "8050538250721",
      "Count": "1"
    }
  ],
  /* objeto de paginación */
  "total_rows": {
    "count": "16266",
    "pages": 163
  }
}

POST

se utiliza para enviar datos al servidor para crear un nuevo recurso o realizar una acción específica en la base de datos. Cuando realiza una solicitud POST, está enviando datos en el cuerpo de la solicitud para que el servidor los procese.

$data = array(
  array("nombre" => "Ejemplo 1", "edad" => 25),
  array("nombre" => "Ejemplo 2", "edad" => 30),
  array("nombre" => "Ejemplo 3", "edad" => 35)
);

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://auto-api.arpia.com/65c6dac0e7-f5749cb628/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POST => true,
  CURLOPT_POSTFIELDS => json_encode($data),
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json"
  )
));

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "Error en la petición: " . $error;
} else {
  echo "Respuesta del servidor: " . $response;
}
/* solicitud POST */
var data = [
  { "nombre": "Ejemplo 1", "edad": 25 },
  { "nombre": "Ejemplo 2", "edad": 30 },
  { "nombre": "Ejemplo 3", "edad": 35 }
];

$.post("https://auto-api.arpia.com/65c6dac0e7-f5749cb628/",JSON.stringify(data), function(response) {
  console.log("Respuesta del servidor:", response);
}).fail(function(error) {
  console.error("Error en la petición:", error);
});

{
   /* respuesta de servidor */
  "result": "OK",
}

datos a tener en cuenta :

❗️

Errores en Nombre de Campos

Los campos deben ser enviados de la forma que están creados en la tabla en el repositorio. En caso de que un campo no esta nombrado correctamente o no existe el mismo, enviara un error en el API.

🚧

Llaves Primarias

En caso que la tabla destino en el repositorio cuente con una llave primaria y existe datos enviados en el API el mismo remplazara los datos de dicho registro único.

📘

Registros con Campos incompletos!

En caso que envíe un registro de datos donde no todos los campos o columnas están contenidos en el payload enviado al API los mismos serán llenados con valores predefinidos, null o vacíos según cómo se haya configurado en la tabla.

✔️

Array de objetos en formato JSON

recuerda utilizar el formato JSON al usar la AutoAPI


What’s Next