Plataforma para developers · API v1

Construye con GuestOS.

API REST pública, webhooks salientes, spec OpenAPI 3.1, llaves de idempotencia y errores estilo Stripe. Todo lo que necesitas para conectar GuestOS a tu CRM, dashboard o flujo de Zapier en minutos.

Leer la documentaciónVer planes

API incluida desde BUSINESS $99/mes. Gratis para desarrollo local — regístrate y crea una llave de prueba.

curl
curl https://guestos.app/api/v1/events/evt_123/stats \
  -H "Authorization: Bearer gos_live_xxxxxxxxxxxxxxxxxxxxxx"

Rápido desde el primer request

Desplegada en el edge de Vercel. Respuesta típica por debajo de 150 ms desde Puerto Rico, LATAM y US East. Rate limits de 3k/min en BUSINESS y 10k/min en ENTERPRISE.

Webhooks, no polling

Suscríbete a 8 tipos de evento (guest.checked_in, rsvp.submitted, event.published y más). Firmados con HMAC-SHA256, reintentos de 5 intentos con backoff exponencial y replay desde la interfaz de ajustes.

Seguridad lista para producción

Llaves de API hasheadas con SHA-256 en la base de datos. HTTPS obligatorio. Errores estilo Stripe con request_id para auditoría. ActivityLog completo por cada request. CORS bloqueado a server-to-server.

Quickstart · 3 pasos

Integra GuestOS en menos de 5 minutos.

Flujo típico: traer datos de invitados a tu propio dashboard o enviar eventos de check-in a HubSpot, Slack o Google Sheets.

  1. 1

    Sube a BUSINESS

    La API está incluida desde $99/mes. Crea una llave de prueba desde Dashboard → Ajustes → Llaves de API.

  2. 2

    Llama a la API

    Envía tu llave como Authorization: Bearer gos_.... Las respuestas son JSON con headers X-Request-Id y X-RateLimit-* en cada response.

  3. 3

    Suscríbete a webhooks (opcional, recomendado)

    En lugar de hacer polling, recibe los eventos directo en tu endpoint. Verifica firmas con nuestro secreto whsec_*. Código de ejemplo en la documentación.

Ejemplo en Node.js
// SDK TypeScript oficial — disponible bajo demanda para clientes BUSINESS+
// Contactar: hola@pintado.ai para acceso
import { GuestOS } from "@guestos/node";

const guestos = new GuestOS({ apiKey: process.env.GUESTOS_API_KEY! });
const stats = await guestos.events.stats("evt_123");
// typed: stats.guests.checkInRate, stats.rsvp.confirmed, stats.payments.totalCollected
Webhooks salientes

Deja el polling. Suscríbete.

8 tipos de evento. Firmados con HMAC-SHA256. Reintentos con backoff exponencial (1 min, 5 min, 30 min, 2 h, 12 h). Auto-desactivación tras 50 fallos consecutivos. Replay desde el dashboard.

guest.checked_in
guest.updated
rsvp.submitted
rsvp.updated
event.published
event.closed
photo.approved
payment.received
Referencia de webhooks
Receptor de webhook
// Receiver example — Express.js
app.post("/hooks/guestos", express.raw({ type: "application/json" }), (req, res) => {
  const sig = req.headers["guestos-signature"];
  if (!verifyWebhook(SECRET, sig, req.body.toString())) return res.sendStatus(401);
  const event = JSON.parse(req.body);
  if (event.type === "guest.checked_in") {
    // push to your CRM, Slack, sheets — whatever
  }
  res.sendStatus(200);
});

Referencia de API

Documentación interactiva — prueba cada endpoint desde el navegador.

SDK de Node

Cliente TypeScript oficial disponible bajo demanda. Si lo necesitas para tu integración, contáctanos directamente.

Spec OpenAPI

Spec JSON sin procesar. Genera SDKs con Fern, Speakeasy u openapi-generator.

Changelog

Cada cambio de la API se anuncia aquí. Compatible con RSS.

Estado

Uptime en vivo y sparkline de la última hora por servicio.

¿Listo para construir?

El acceso a la API está incluido en los planes BUSINESS y ENTERPRISE. Si tienes el caso de uso, contáctanos y te ayudamos a arrancar.

Ver planesSolicitar acceso API