Skip to main content
@timbrix/sdk es el cliente oficial de Timbrix para Node.js (18+) y el navegador — tipado completo (sin any), sin dependencias además de ky, y con manejo de errores tipado listo para usar.

Paquete en npm

@timbrix/sdk

Instalación

Quickstart

Sigue el mismo flujo que en Quickstart — regístrate en app.timbrix.mx/register, copia tu API key de sandbox desde Configuración → API Keys, y crea cliente → producto → CFDI en ese orden.
Para pasar a producción, cambia la API key de sandbox por una sk_live_... — la URL base, los endpoints y las respuestas son idénticos en ambos entornos.

Autenticación

No hay una URL base distinta para sandbox — la misma https://api.timbrix.mx recibe ambos tipos de key, y el API decide el entorno según la key usada. Ver Authentication para el flujo de OAuth 2.0.

Manejo de errores

Toda petición fallida rechaza con un TimbrixApiError — nunca el HTTPError genérico de ky. Incluye el mensaje del API (los arreglos de validación se unen en un solo string), el código de error de dominio, una sugerencia opcional y el status HTTP:
Los errores de rate limit (statusCode === 429) reciben automáticamente un hint (retry after Ns) en message cuando el API envía un header Retry-After.

Referencia completa

El README del paquete documenta cada resource (invoices, customers, products, sat, organizations, webhooks, apiKeys, oauth, auth, users) con ejemplos. Para el detalle de cada endpoint REST subyacente, ver API Reference.