---
title: "Autenticación de la API: documentación de CheckoutOS"
description: "Acceso seguro a la API de CheckoutOS. De la sección “Referencia de la API” de la documentación de Chargezen CheckoutOS."
url: "https://chargezen.com/es/docs/checkoutos/api/authentication"
lang: "es"
updated: "2025-01-16"
---

Canonical URL: https://chargezen.com/es/docs/checkoutos/api/authentication

# Autenticación de la API

Acceso seguro a la API de CheckoutOS

Última actualización: 2025-01-16

La API de CheckoutOS usa claves de API para autenticar. Esta guía explica cómo generar claves, autenticar solicitudes y gestionar el acceso de forma segura.

## Claves de API

Las claves autentican todas las solicitudes a la API de CheckoutOS. Cada clave pertenece a tu tienda y tiene permisos configurables.

### Generar claves de API

1

#### Ir a configuración

Ve a CheckoutOS → Settings → API.

2

#### Crear una clave

Haz clic en “Create API Key”.

3

#### Nombrar la clave

Ponle un nombre descriptivo, como “Servidor de producción”.

4

#### Fijar permisos

Elige a qué ámbitos de la API puede acceder.

5

#### Copiar la clave

Cópiala de inmediato: no volverá a mostrarse.

Seguridad de las claves

Las claves solo se muestran una vez al crearlas. Guárdalas de forma segura. Si las pierdes, tendrás que generar una nueva.

## Métodos de autenticación

### Token Bearer, recomendado

Incluye la clave como token Bearer en la cabecera Authorization:

Autenticación con token Bearer

```bash
curl -X GET "https://api.chargezen.com/v1/checkoutos/upsells" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Cabecera X-API-Key

También puedes usar la cabecera X-API-Key:

Autenticación con X-API-Key

```bash
curl -X GET "https://api.chargezen.com/v1/checkoutos/upsells" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

## Permisos de API

Puedes limitar las claves a permisos específicos:

Ámbitos disponibles

```json
{
  "scopes": {
    "read:upsells": "View upsell configurations",
    "write:upsells": "Create and modify upsells",
    "read:bundles": "View bundle configurations",
    "write:bundles": "Create and modify bundles",
    "read:analytics": "Access analytics data",
    "read:orders": "View order data",
    "write:orders": "Modify orders (edits)",
    "read:settings": "View CheckoutOS settings",
    "write:settings": "Modify settings",
    "webhooks:manage": "Create and manage webhooks"
  }
}
```

Privilegio mínimo

Concede solo los permisos que necesite la integración. Una clave para paneles analíticos no debería poder modificar ventas adicionales.

## Límites de solicitudes

Las solicitudes se limitan para asegurar un uso equitativo:

Límites de solicitudes

```json
{
  "rate_limits": {
    "requests_per_minute": 120,
    "requests_per_hour": 3600,
    "burst_limit": 20
  },
  "headers": {
    "X-RateLimit-Limit": "120",
    "X-RateLimit-Remaining": "115",
    "X-RateLimit-Reset": "1640000000"
  }
}
```

Si alcanzas el límite, recibirás una respuesta 429:

Respuesta por límite alcanzado

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 45 seconds.",
    "retry_after": 45
  }
}
```

## Entornos

CheckoutOS ofrece entornos separados de desarrollo y producción:

Entornos de API

```json
{
  "production": {
    "base_url": "https://api.chargezen.com/v1",
    "key_prefix": "live_"
  },
  "sandbox": {
    "base_url": "https://sandbox.api.chargezen.com/v1",
    "key_prefix": "test_"
  }
}
```

Entorno de pruebas

Usa el entorno de pruebas para desarrollar y probar. Sus datos están separados de producción y se pueden restablecer en cualquier momento.

## SDK oficiales

Los SDK oficiales gestionan automáticamente la autenticación:

SDK de Node.js

```javascript
import { CheckoutOS } from '@chargezen/checkoutos-sdk';

const client = new CheckoutOS({
  apiKey: process.env.CHARGEZEN_API_KEY,
  environment: 'production'
});

const upsells = await client.upsells.list();
```

SDK de Python

```python
from chargezen import CheckoutOS

client = CheckoutOS(
    api_key=os.environ['CHARGEZEN_API_KEY'],
    environment='production'
)

upsells = client.upsells.list()
```

## Gestionar claves

#### Buenas prácticas

*   Usa variables de entorno — Nunca escribas las claves directamente en el código
*   Rota las claves regularmente — Al menos cada trimestre
*   Usa claves distintas por entorno — Desarrollo, preproducción y producción
*   Revoca claves sin uso — Elimina las que ya no necesitas
*   Supervisa el uso — Busca patrones anómalos
*   Usa ámbitos mínimos — Concede solo los permisos necesarios

## Revocar claves

1

#### Ir a configuración de la API

Ve a CheckoutOS → Settings → API.

2

#### Encontrar la clave

Localiza la clave que quieres revocar.

3

#### Revocar

Haz clic en “Revoke” y confirma.

Efecto inmediato

La revocación es inmediata. Cualquier solicitud con esa clave fallará. Actualiza tus aplicaciones antes de revocarla.

## Referencia de la API

[

### Endpoints de la API

Endpoints disponibles

Más información



](https://chargezen.com/es/docs/checkoutos/api/endpoints)[

### Webhooks

Notificaciones de eventos en tiempo real

Más información



](https://chargezen.com/es/docs/checkoutos/api/webhooks)

¿Te resultó útil esta página?

¿Necesitas más ayuda? [Contactar con soporte](https://chargezen.com/es/docs/checkoutos/troubleshooting/support)