API Quickstart y documentación de la API

Si vas a integrar tu sistema con Peakly, el API Quickstart es el camino más corto: un asistente de cuatro pasos que crea una API key, un producto, un cliente y una factura reales usando la API, mostrándote en cada paso el código listo para copiar. Cuando termines, la referencia completa de endpoints está en la documentación pública de la API.

Cómo entrar

En el menú lateral, en el grupo Conectar, entrá a Desarrolladores y elegí API Quickstart (también figura como Ver docs en la integración API y Webhooks del catálogo). Se abre una pantalla completa con una barra de progreso con los cuatro pasos y un enlace API Docs arriba a la derecha.

Los cuatro pasos

Paso 1: Crear API Key

1. Escribí un Nombre (por ejemplo "Mi integración") y elegí el Vencimiento: 30, 60, 90 días o Sin vencimiento
2. Hacé clic en Crear API Key
3. Copiá la key: es la única vez que se muestra. Se usa en el header x-api-key de cada request

El botón Continuar queda deshabilitado hasta que crees la key. Esta key es una más de las que ves en Desarrolladores > API Keys.

Paso 2: Crear un producto

Completás los datos de un producto de prueba y el asistente muestra el request equivalente (POST /products). También lista las unidades de medida disponibles en tu organización, que necesitás para el campo de unidad. El producto queda guardado para usarlo en la factura del paso 4.

Paso 3: Crear un cliente

Igual que el anterior, pero para un cliente (POST /customers). Los campos marcados como opcionales los podés dejar vacíos.

Paso 4: Facturar

Elegís el Talonario y la forma de emitir, en dos pestañas:

• Con creación previa: reutiliza el cliente y el producto de los pasos 2 y 3
• Single request: crea cliente, producto y comprobante en un solo POST

En los pasos 2, 3 y 4 hay un botón Probar en vivo que ejecuta el request real contra tu cuenta y muestra la respuesta. Si te salteaste algún paso previo, el paso 4 te avisa que vuelvas a ese paso y uses Probar en vivo.

Al terminar

Con Continuar avanzás y con Atrás volvés al paso anterior. En el último paso el botón pasa a Completar y llegás a una pantalla de cierre que resume el flujo (crear comprobante, encolado, CAE otorgado), indica cómo descargar el PDF y ofrece los botones Ver documentación completa e Ir al Dashboard.

La referencia de la API en /docs

La documentación pública está en peakly.ar/docs (también accesible desde el enlace API Docs del quickstart). No necesitás iniciar sesión para leerla.

• Explicación de los requisitos previos (organización, API key y facturación configurada) y de la autenticación con el header de la API key
• Referencia interactiva de todos los endpoints, con parámetros y ejemplos de respuesta; podés probar requests con tu API key desde el navegador
• Selector de idioma (español / inglés)
• Botón Descargar colección Postman para importar todos los endpoints en Postman
• El esquema OpenAPI en formato JSON (api.peakly.ar/openapi.json) para generar clientes o importarlo en Insomnia