Creá una API key

Una API key le da a tu servidor acceso a una organización de Commet. Empezá con una organización sandbox mientras desarrollás la integración.

Las keys nuevas de acceso completo empiezan con ck_sandbox_ o ck_live_; las restringidas, con rk_sandbox_ o rk_live_. Las keys anteriores que empiezan con ck_ siguen funcionando. La organización que creó la key determina a qué datos puede acceder. Ambos entornos usan https://commet.co/api/v1.

Creá una key

Elegí el camino que corresponda a tu forma de trabajar. Solo necesitás uno para empezar.

npm install -g commet
commet login
commet link

commet api-keys create --name "Desarrollo local" --expires-in-days 365

{
  "body": {
    "name": "Desarrollo local",
    "expiresInDays": 365
  }
}

¿Ya te autenticás con una API key de acceso completo? Podés crear reemplazos con POST /api/v1/api-keys. Ese request crea otra key para la misma organización. Consultá Create API key para ver el request y la respuesta.

Limitá los permisos de una key

Si omitís permissions, la key tiene acceso completo. Si indicás permisos por recurso, queda restringida. Por ejemplo, customer: ["read"] permite leer customers, pero no modificarlos. El acceso de escritura requiere tanto "read" como "write". Un objeto vacío ({}) no da acceso a ningún recurso.

Una key restringida con api_key: ["read", "write"] puede crear keys restringidas con los mismos permisos o menos. Esas keys vencen como máximo cuando vence la key que las crea. Las keys restringidas no pueden editar ni eliminar API keys.

const key = await commet.apiKeys.create({
  name: "Lectura de customers",
  permissions: { customer: ["read"] },
})

El secreto completo se devuelve una sola vez. Guardalo en tu secret store antes de cerrar la respuesta.

Guardá la key en tu servidor

Para desarrollo local, guardala en un archivo de entorno excluido de Git:

COMMET_API_KEY=ck_reemplaza_con_tu_key

Cargá la variable en el proceso de tu servidor con el mecanismo de tu framework. En producción, usá el secret store del deploy. Nunca expongas la key en código del navegador, variables públicas, logs, screenshots ni control de versiones.

Commet guarda un hash de la key y no puede volver a mostrar el secreto completo. Si lo perdés, creá un reemplazo.

Usá la key en tu SDK

Para Node.js, instalá el SDK:

npm install @commet/node

Inicializalo en código del servidor después de cargar el entorno:

import { Commet } from "@commet/node"

const apiKey = process.env.COMMET_API_KEY
if (!apiKey) {
  throw new Error("COMMET_API_KEY is required")
}

export const commet = new Commet({ apiKey })

Para otros lenguajes, seguí la guía de Python, Go, Java o PHP. Los requests REST directos se autentican con el header x-api-key.

Rotá la key y pasá a live

Usá una key independiente por aplicación o deploy que necesite su propia rotación. Para reemplazar una key antes de que venza:

1. Creá el reemplazo en la misma organización.
2. Actualizá el secreto en todos los procesos que usan la key anterior y desplegalos o reinicialos.
3. Verificá una lectura exitosa con la nueva key y confirmá que la aplicación la está usando.
4. Eliminá la anterior desde Settings → API Keys o con Delete API key.

Para producción, creá una key en tu organización live y guardala separada de las credenciales de sandbox. No copies IDs de customers, planes ni suscripciones de sandbox a la configuración live. Antes del cambio, verificá checkout, webhooks y una renovación en sandbox con el Test Clock.

Después, seguí el quickstart para completar el primer pago de una suscripción en sandbox.