Referencia del SDK
Configuración, entornos y paginación
Setup
import { Commet } from '@commet/node'
const commet = new Commet({
apiKey: process.env.COMMET_API_KEY!,
})Obtén tu API key desde el dashboard.
Opciones
| Opción | Tipo | Default | Descripción |
|---|---|---|---|
apiKey | string | requerido | Tu API key (empieza con ck_). La org dueña de la key decide si las llamadas corren contra datos sandbox o live. |
debug | boolean | false | Loguea requests/responses |
timeout | number | 30000 | Timeout del request (ms) |
retries | number | 3 | Cantidad máxima de reintentos |
Sandbox vs live
Hay un único host de API, commet.co. Usa una API key creada en una organización sandbox mientras integras; cámbiala por una key de organización live cuando pases a producción. No hay cambios de código más allá de la variable de entorno.
Modo debug
Ver todos los requests y responses:
const commet = new Commet({
apiKey: process.env.COMMET_API_KEY!,
debug: true,
})
// [Commet SDK] POST https://commet.co/api/customers
// [Commet SDK] Response status: 200 OKPaginación
Los endpoints de listado usan paginación basada en cursor.
const page = await commet.customers.list({ limit: 25 })
if (page.hasMore) {
const nextPage = await commet.customers.list({
limit: 25,
cursor: page.nextCursor,
})
}| Parámetro | Tipo | Default | Descripción |
|---|---|---|---|
limit | number | 25 | Items por página (máx 100) |
cursor | string | - | Cursor del response anterior |
¿Cómo está esta guía?