API REST

Crea integraciones potentes.

Una API REST JSON versionada y protegida con autenticación por clave. Suscríbete a webhooks para 12 eventos de trabajos, facturas, pagos, presupuestos y clientes. Disponible en el plan Scale.

Autenticación por clave REST versionada · v1 12 eventos de webhook 5 jurisdicciones
bash · Crear un trabajo mediante la API REST
curl https://api.servicesynchq.com/api/v1/jobs \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": 12345,
    "scheduledDate": "2026-08-20T14:00:00Z",
    "title": "HVAC repair"
  }'
json · Respuesta · en streaming
201 Created
{  "id": 84213,  "customerId": 12345,  "status": "scheduled",  "scheduledDate": "2026-08-20T14:00:00Z",  "title": "HVAC repair",  "createdAt": "2026-07-24T08:14:22Z"}
API REST · v1
Estable, versionada, JSON
X-API-Key
Autenticación por clave
CRUD completo
En todos tus datos
12 eventos
Webhooks en tiempo real
Referencia de la API

Endpoints principales

Una muestra de todo lo que ofrece. Clientes, trabajos, facturas, presupuestos, pagos, inventario, agenda y notificaciones exponen CRUD completo sobre JSON.

REST · /api/v1

CRUD completo sobre JSON, protegido con tu X-API-Key.

/customers/jobs/estimates /invoices/payments/inventory
Webhooks · 12 eventos

Registra un endpoint y reacciona en tiempo real.

job.createdinvoice.paidpayment.received estimate.acceptedcustomer.created

Dos formas de integrar: REST para lectura/escritura y webhooks para envíos push en tiempo real.

200 OK GET

/api/v1/customers

Lista todos los clientes.

paginación por cursor
201 Created POST

/api/v1/customers

Crea un nuevo cliente.

compatible con idempotency-key
200 OK GET

/api/v1/jobs

Lista los trabajos filtrados por estado o fecha.

ordenable + filtrable
201 Created POST

/api/v1/jobs

Programa un nuevo trabajo. Dispara el job.created webhook.

registrado en auditoría
200 OK GET

/api/v1/invoices

Lista las facturas con paginación.

según la jurisdicción
202 Accepted POST

/api/v1/invoices/:id/send

Envía la factura por correo electrónico o SMS. IRN generado automáticamente para IN.

respaldado por cola de reintentos

Una muestra representativa de clientes · trabajos · presupuestos · facturas · pagos · inventario · compras · programación · notificaciones. Cada llamada con privilegios queda registrada en la auditoría. Ver la referencia completa →

Cumplimiento global · C7

5 jurisdicciones, una sola API

Pasa un código de país y obtén el cálculo fiscal correcto, el diseño de documento correcto y el payload de factura electrónica correcto. Los mismos endpoints, con comportamiento adaptado a cada jurisdicción: sin bifurcaciones por país en el código de tu integración.

GST de IndiaImpuesto sobre ventas de EE. UU.VAT del Reino UnidoVAT de la UEVAT del CCG
IN IndiaCGST + SGST intraestatal · IGST interestatal · factura electrónica IRN (ventana de cancelación de 24 h) · códigos HSN
UK Reino UnidoRetención CIS del 20% / 30% / 0% (deducida automáticamente según el estado de registro) · declaraciones de VAT
EU UE (SDI XML)Formato italiano de factura electrónica SDI XML · enrutamiento transfronterizo del VAT · inversión del sujeto pasivo
SA Arabia Saudí (ZATCA Fase 1)Bilingüe árabe/inglés · código QR TLV con 5 etiquetas obligatorias · VAT del 15%
AE EAU / CCGVAT del 5% · compatibilidad con facturas en árabe · campos de cumplimiento de la FTA
CA CanadáEnrutamiento de GST · HST · PST · QST por provincia · facturas listas para la CRA
AU AustraliaGST del 10% · retención ABN del 49% (proveedor sin ABN)
US Estados UnidosEnrutamiento del impuesto estatal sobre ventas · destino/origen · gestión de certificados de reventa
Motor fiscal

Cálculos de cumplimiento, automatizados

Indica tu intención y nosotros calculamos el desglose fiscal correcto. Los cambios de estado, de registro o de jurisdicción son datos, no código. Aislamiento de nivel bancario: los datos de cada cliente viven en su propia bóveda lógica, y la propia base de datos se niega a mezclar datos entre bóvedas, no solo el código de la aplicación.

Enrutamiento intraestatal vs. interestatal

¿El estado del proveedor coincide con el del cliente? CGST + SGST. ¿Es distinto? IGST. Se calcula a partir de company.state vs customer.state.

Factura electrónica IRN de GST en India

Genera el IRN + un QR firmado al hacer POST. 24h cancellation window expuesto mediante un endpoint dedicado. Códigos HSN mediante búsqueda.

Deducción CIS del Reino Unido

Deduce automáticamente 20% / 30% / 0% según el estado de registro del contratista, por cada subcontratista.

QR TLV de ZATCA (Arabia Saudí)

Factura bilingüe de la Fase 1 + QR TLV que codifica todas 5 mandatory tags. Se valida con ZATCA antes de renderizar.

Autenticación

Autenticación y seguridad

Cada solicitud se autentica con una clave API enviada en el X-API-Key encabezado. Las claves las crean los administradores de tu espacio de trabajo, revocables en cualquier momento, y cada llamada con privilegios queda registrada en la auditoría.

Clave de API ••••••••

Las claves se muestran una sola vez al crearlas y se almacenan solo como hash, nunca en texto plano.

  • Autenticación por clave de API Envía tu clave secreta en el X-API-Key encabezado en cada solicitud.
  • Creadas y revocadas por tus administradores Genera y revoca claves en Configuración → Claves API. La revocación de una clave surte efecto de inmediato.
  • Con hash en reposo Solo se almacena un hash irreversible de cada clave; la clave en bruto se muestra una sola vez, en el momento de su creación.
  • Registro de auditoría en cada llamada privilegiada Quién, cuándo, desde dónde y qué cambió: a prueba de manipulaciones y visible para los administradores de tu espacio de trabajo.
  • Disponible en el plan Scale El acceso programático a la API está incluido en el plan Scale.
bash · Autenticar una solicitud
curl https://api.servicesynchq.com/api/v1/customers \
  -H "X-API-Key: YOUR_API_KEY"

# 200 OK — returns your customers as JSON.
# Manage keys under Settings → API keys (admin only).
Webhooks · 12 eventos

Reacciona a cada evento en tiempo real

Suscríbete a eventos del ciclo de vida en CRM, despacho, facturación, pagos, compras y auditoría. Cada webhook está firmado criptográficamente, se reintenta con retroceso exponencial y cuenta con una cola de reintentos duradera.

job.created

Nuevo trabajo creado.

job.completed

Trabajo marcado como completado.

job.status_changed

Un trabajo pasó a un nuevo estado.

invoice.created

Nueva factura creada.

invoice.paid

Pago de factura recibido.

invoice.overdue

La factura superó su fecha de vencimiento sin pagar.

payment.received

Se registró el pago de un cliente.

customer.created

Nuevo cliente añadido.

estimate.sent

Presupuesto enviado al cliente.

estimate.accepted

El cliente aceptó el presupuesto.

estimate.rejected

estimate.rejected

estimate.converted_to_job

Presupuesto aceptado convertido en un trabajo.

SDK

Bibliotecas cliente — en la hoja de ruta

Los SDK oficiales están en desarrollo. Hasta que estén listos, la API REST está completamente documentada arriba y funciona con cualquier cliente HTTP.

Node.js

Próximamente

Python

Próximamente

PHP

Próximamente

Ruby

Próximamente
Aislamiento

Aislamiento entre inquilinos, garantizado en la base de datos

Cada solicitud se acota automáticamente a tu espacio de trabajo en la capa de base de datos — no solo en el código de la aplicación. Una consulta de un espacio de trabajo literalmente no puede leer los datos de otro — la propia base de datos lo impide.

  • ✓ Aislamiento aplicado en la capa de base de datos
  • ✓ Verificado por una suite de pruebas de aislamiento automatizada
  • ✓ Los intentos de join entre inquilinos devuelven vacío, nunca un error
  • ✓ Suplantación por superadministrador registrada en la auditoría
Business C Fully isolated Business B Fully isolated Business A Fully isolated POSTGRES · ROW-LEVEL SECURITY POLICIES
Límites de tasa

Generosos, transparentes: los encabezados te lo indican

Límites de uso justo con capacidad de ráfaga. Tu límite actual y la cuota restante se devuelven en cada respuesta en X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset encabezados (borrador del estándar IETF). Nunca tendrás que adivinar qué está permitido.

Estándar

Solo · Essentials · Growth

Incluido en todos los planes con acceso a la API.

Valores predeterminados generosos

Margen suficiente para integraciones habituales · los encabezados te muestran en tiempo real

Enterprise

Scale + complemento Enterprise

Límites personalizados, capacidad dedicada y SLA.

Personalizado

Contactar con ventas para dimensionarlo

Cuando alcanzas un límite: recibirás un HTTP 429 Too Many Requests con un Retry-After en el encabezado, en segundos. Nuestros SDK gestionan esto automáticamente con reintentos de retroceso exponencial. Si necesitas límites más altos con regularidad, habla con nosotros — las cifras publicadas son mínimos, no máximos.
Seguridad

Tus claves API, tratadas como los secretos que son

Protegemos tus claves como querríamos que protegieran las nuestras. Esto es con lo que puedes contar.

Solo TLS, en todas partes

Cada solicitud a la API se cifra en tránsito con TLS moderno. El HTTP sin cifrar se rechaza en el perímetro.

Acotado al espacio de trabajo por diseño

Cada clave de API está vinculada a un único espacio de trabajo. No existe ninguna vía por la que una clave del espacio de trabajo A pueda leer datos del espacio de trabajo B: se aplica en la capa de base de datos, no solo en la aplicación.

Registro de auditoría en cada llamada privilegiada

página de seguridad página de seguridad.

Revocación de claves instantánea

¿Sospechas de una filtración? Revoca la clave en el panel de administración y dejará de funcionar de inmediato. Emite una clave nueva y actualiza tu integración.

Almacenado como hash en reposo

Solo se almacena un hash irreversible de cada clave. La clave sin procesar se muestra una sola vez, al crearla, y nunca se guarda en texto plano.

Registro de auditoría en cada llamada

Cada acción privilegiada de la API queda registrada —quién, cuándo, desde dónde y qué cambió— en un registro a prueba de manipulaciones que tus administradores pueden revisar.

Buenas prácticas para proteger tus claves de API

Nunca subas claves a git Usa variables de entorno o un gestor de secretos. Si filtras una, rótala en nuestro panel de administración antes de publicar la corrección.
Llama a la API desde tu backend Mantén las claves en el servidor: nunca las expongas en un navegador ni en una aplicación móvil.
Rótalas cada trimestre O cada vez que alguien con acceso a las claves deje tu equipo.
Una clave por integración Una clave distinta por integración significa que puedes revocar solo una si se filtra.
Guarda las claves en un gestor de secretos Variables de entorno o un vault: nunca en el control de código fuente ni en un documento compartido.
Vigila el registro de auditoría Una IP desconocida usando tu clave es una señal que conviene investigar.

¿Listo para construir?

El acceso a la API está incluido en el plan Scale. Lee primero la documentación y obtén tus claves cuando estés listo.