API REST · esquema OpenAPI

Construya sobre PrivateCore

Una API REST y un principio: funciona en su instancia, nunca en un servidor compartido con otros clientes. En línea, es el servidor alquilado para usted; con el Mac mini, es la máquina de su mostrador. Las claves son suyas y las revoca con un clic.

Lo que permite la API

  • Conectar sus herramientas a medida: una tabla de Airtable, un Slack, un ERP heredado, un panel de Grafana propio.
  • Automatizar lo que repite: generar las facturas recurrentes del mes, lanzar un recordatorio cuando un presupuesto lleva 7 días sin firmar, sincronizar el stock con un proveedor.
  • Construir aplicaciones internas: una aplicación móvil para el equipo de sala, un widget de reservas en su web escaparate, un panel multicentro a medida para la dirección.
  • Auditar y exportar: recuperar toda su contabilidad en JSON, generar un fichero contable FEC a demanda, replicar su base en su propio almacén de datos.

Dos ejemplos de llamada

TypeScript

fetch
TypeScript 
const base = 'https://votre-instance';
const headers = { Authorization: `Bearer ${process.env.PRIVATECORE_API_KEY}` };

// Listar los clientes (clave con alcance read:crm)
const { items, next_cursor } = await fetch(`${base}/api/public/v1/clients?limit=50`, { headers })
  .then((r) => r.json());

Python

requests
Python 
import os
import requests

base = "https://votre-instance"
headers = {"Authorization": f"Bearer {os.environ['PRIVATECORE_TOKEN']}"}

# Exportar el fichero contable FEC del ejercicio en curso
fec = requests.get(f"{base}/api/fec/export", params={"year": 2026}, headers=headers)
open("fec_2026.txt", "wb").write(fec.content)

Autenticación

Claves de API con alcance limitado, revocables, con fecha de caducidad si lo desea.

  • Creación: una clave por integración, desde el espacio Desarrollador de su instancia. Usted elige sus alcances (lectura de clientes, de reservas, etc.).
  • Nunca legibles después: la clave se muestra una sola vez, al crearla. Su instancia solo guarda una huella SHA-256. Si la pierde, la revoca y crea otra.
  • Seguimiento: cada clave conserva la fecha de su último uso, para detectar las que ya no sirven.
  • Revocación instantánea: basta un clic. El token deja de ser válido de inmediato.

Límites de uso

Ninguna cuota facturada. Cada clave está limitada a 60 peticiones por minuto (ajustable en la instancia), para que un script desbocado no ralentice la interfaz de los demás usuarios.

Por encima, la API responde 429 con una cabecera Retry-After: el script espera un minuto y continúa.

Documentación y estado

  • Documentación completa: /docs en su instancia (referencia OpenAPI generada a partir del código).
  • Registro de cambios: cada versión del backend expone un punto de acceso /api/v1/changelog.
  • OpenAPI: especificación OpenAPI 3.1 disponible en claro en /api/openapi.json. Compatible con Postman, Insomnia y generadores de código de terceros.
  • Estado: la API expone puntos de salud (/health, /health/ready) que una herramienta de supervisión puede consultar.
Solicitar acceso a la API

¿Listo para recuperar el control?

Una instalación a medida, una respuesta del fundador y un Mac Mini que compra usted o que le entregamos configurado.

Pedir Hablar con un fundador