• Precios
  • Blog
Iniciar sesiónAgendá una demo
Introducción

Inicio rápido

Aprender

Recursos

Referencia del SDKVersionado de APIManejo de erroresTestingCLI

Plugins

Better Auth
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

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 en Settings → API Keys.

Opciones

OpciónTipoDefaultDescripción
apiKeystringrequeridoTu API key (empieza con ck_). La org dueña de la key decide si las llamadas corren contra datos sandbox o live.
apiVersionstringversión con la que se compiló la release del SDKPin de versión de API, enviado como header Commet-Version en cada request. Mira Versionado de API.
debugbooleanfalseLoguea requests/responses
timeoutnumber30000Timeout del request (ms)
retriesnumber3Cantidad máxima de reintentos
telemetrybooleantrueEnvía info anónima del cliente (versión del SDK, runtime, plataforma) con los requests. Ponlo en false para desactivarlo.

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/v1/customers
// [Commet SDK] Response status: 200 OK

Paginació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ámetroTipoDefaultDescripción
limitnumber25Items por página (máx 100)
cursorstring-Cursor del response anterior

¿Cómo está esta guía?

Política de uso aceptable

Qué productos y servicios pueden venderse a través de Commet.

Versionado de API

Cómo Commet versiona su API y webhooks para que tu integración nunca se rompa inesperadamente.

On this page

Setup
Opciones
Sandbox vs live
Modo debug
Paginación