API Reference

La API de VexoPos te permite integrar tu sistema con nuestra plataforma POS. Utiliza nuestra API RESTful para gestionar productos, ventas, clientes y mas.

https://api.vexopos.com/v1

Autenticacion

La API de VexoPos utiliza API Keys para autenticar las peticiones. Puedes obtener tu API Key desde el dashboard de tu cuenta.

API Key Authentication

Incluye tu API Key en el header Authorization de cada peticion usando el esquema Bearer.

HTTP Header 
Authorization: Bearer vxp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Productos

Endpoints para gestionar el catalogo de productos de tu negocio.

GET /products

Obtiene la lista de todos los productos. Soporta paginacion y filtros.

Query Parameters

Parametro Tipo Descripcion
page opcional integer Numero de pagina (default: 1)
limit opcional integer Productos por pagina (max: 100, default: 20)
category_id opcional string Filtrar por categoria
Response 
{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Coca Cola 500ml",
      "sku": "BEB-001",
      "price": 25.00,
      "stock": 150,
      "category_id": "cat_beverages"
    }
  ],
  "meta": {
    "total": 245,
    "page": 1,
    "limit": 20
  }
}
POST /products

Crea un nuevo producto en el catalogo.

Body Parameters

Parametro Tipo Descripcion
name requerido string Nombre del producto
price requerido number Precio de venta
sku opcional string Codigo SKU unico
category_id opcional string ID de la categoria

Ventas

Endpoints para registrar y consultar transacciones de venta.

POST /sales

Registra una nueva venta con sus items y metodo de pago.

Request Body 
{
  "items": [
    {
      "product_id": "prod_abc123",
      "quantity": 2,
      "price": 25.00
    }
  ],
  "payment_method": "cash",
  "customer_id": "cust_xyz789",
  "discount": 0
}
GET /sales/{sale_id}

Obtiene los detalles de una venta especifica.

Codigos de Error

La API utiliza codigos de estado HTTP estandar para indicar el resultado de las peticiones.

Codigo Descripcion
200 Peticion exitosa
201 Recurso creado exitosamente
400 Peticion invalida - revisa los parametros
401 No autorizado - API key invalida o faltante
404 Recurso no encontrado
429 Rate limit excedido
500 Error interno del servidor

Rate Limits

Para garantizar la estabilidad del servicio, aplicamos limites de peticiones por minuto segun tu plan.

Plan Limite
Starter 100 peticiones/minuto
Professional 500 peticiones/minuto
Enterprise 2000 peticiones/minuto