Documentacion de APIs

Referencia completa de endpoints, queries SQL, y conexion a base de datos

36

Endpoints

74

Queries SQL

17

Tablas

14

Secciones

Conexion a Base de Datos (Neon PostgreSQL)

Libreria:

@neondatabase/serverless

Variable de entorno:

process.env.DATABASE_URL

Import e inicializacion:

import { neon } from "@neondatabase/serverless"
const sql = neon(process.env.DATABASE_URL!)

// Uso con tagged template literals:
const rows = await sql`SELECT * FROM merchants WHERE client_id = ${clientId}`

Notas para migracion:

  • Todas las queries usan tagged template literals de @neondatabase/serverless.
  • Para migrar a otro proveedor PostgreSQL, reemplazar 'neon' por el driver correspondiente (pg, postgres, etc.).
  • Las queries SQL son PostgreSQL estandar y no usan extensiones especificas de Neon.
  • El driver de Neon se conecta via HTTP/WebSocket, otros drivers pueden usar conexion TCP directa.
  • La variable de entorno DATABASE_URL debe apuntar al nuevo servidor PostgreSQL.
  • Formato tipico: postgresql://user:password@host:5432/database?sslmode=require
  • Para drivers como 'pg' (node-postgres): new Pool({ connectionString: process.env.DATABASE_URL })
  • Para 'postgres' (postgres.js): postgres(process.env.DATABASE_URL)

Ejemplo de migracion a node-postgres (pg):

// Antes (Neon):
import { neon } from "@neondatabase/serverless"
const sql = neon(process.env.DATABASE_URL!)
const rows = await sql`SELECT * FROM merchants WHERE client_id = ${clientId}`

// Despues (pg / node-postgres):
import { Pool } from "pg"
const pool = new Pool({ connectionString: process.env.DATABASE_URL })
const { rows } = await pool.query("SELECT * FROM merchants WHERE client_id = $1", [clientId])

// Despues (postgres.js):
import postgres from "postgres"
const sql = postgres(process.env.DATABASE_URL!)
const rows = await sql`SELECT * FROM merchants WHERE client_id = ${clientId}`

Dashboard

Estadisticas y metricas generales del sistema.

Company

Informacion de la empresa/cliente PSP.

Comercios

ABM de comercios, canales, comisiones, establecimientos, terminales y codigos QR.

Auth Comercio

Autenticacion y listado de comercios para el portal del comercio.

Cobranzas

Gestion de transacciones de cobro (LINK, CHECKOUT, QR, POS).

Importador

Importacion de archivos CSV de transacciones POS (Payway, etc).

POS Transactions

Transacciones POS importadas.

Liquidaciones

Ordenes de liquidacion que agrupan transacciones para pago al comercio.

Merchant Liquidaciones

Liquidaciones vistas desde el portal del comercio.

Acreditaciones

Acreditaciones que agrupan liquidaciones para transferencia al comercio.

Adelantos

Solicitudes de adelanto de cobros futuros.

Feriados

ABM de feriados para calculo de dias habiles.

Aranceles

Consulta de aranceles y comisiones de un comercio.

Links de Pago

Gestion de links de pago para comercios.