Conceptos clave

Una mirada más profunda a los términos introducidos en el Inicio rápido.

1. API

Un protocolo de comunicación para intercambiar datos entre programas.

En 3Min API:

• Crea APIs sin código backend
• Recibe datos JSON estándar
• Los datos se almacenan automáticamente y se pueden reenviar vía webhooks

2. Endpoint

La dirección API que recibe datos. Una API = un endpoint.

Cada endpoint incluye:

• Ruta URL única (generada automáticamente)
• Campos obligatorios (opcional)
• Separación de entornos Sandbox/Producción
• Claves API específicas por entorno (tm_test_xxx..., tm_live_xxx...)

3. JSON

3Min API acepta datos JSON estándar.

Tipos de campo soportados:

Ejemplo (información de pedido):

{
  "order_id": "ORD-2024-001",
  "amount": 45000,
  "items": ["Item A", "Item B"],
  "paid": true,
  "customer": {
    "name": "John Doe",
    "phone": "010-1234-5678"
  }
}

4. Campos obligatorios (opcional)

Puedes especificar campos que deben incluirse en los datos JSON.

Con campos obligatorios:

• Las solicitudes sin campos obligatorios se rechazan (error 400)
• Asegura la calidad de los datos
• Los campos de cadena se pueden hacer buscables en los registros

5. Sandbox vs Producción

• El entorno se determina por el prefijo de la clave API
• Los webhooks se pueden configurar por separado para cada entorno
• Prueba a fondo en Sandbox antes de desplegar a Producción

6. Clave API

Se usa para autenticación al llamar endpoints. La clave API predeterminada del propietario se genera automáticamente al crear el endpoint y no se puede eliminar. Si la clave se compromete, se puede regenerar.

Claves de colaboración

Crea claves de colaboración e invita colaboradores para gestionar registros y estadísticas por separado por clave de colaboración.

Filtra registros por clave de colaboración para rastrear el uso por clave.

Establece las operaciones permitidas (POST/GET/PUT/DELETE) por clave de colaboración, de forma independiente para cada entorno.

7. Webhooks

Notificaciones automáticas enviadas a una URL especificada cuando llegan datos.

Dos tipos de webhooks:

Política de reintentos: hasta 3 reintentos en caso de fallo (intervalos de 60 segundos)

Nota: incluso si todos los reintentos del webhook fallan, tus datos siguen almacenados de forma segura. Verifica el estado del webhook en los registros.

8. Alertas de eventos (Discord / Slack / Telegram)

Recibe notificaciones instantáneas para eventos importantes vía Discord, Slack o Telegram.

Configuración: Panel → APIs → Detalle del endpoint → Configuración de notificaciones

Eventos soportados:

• Fallo en la entrega del webhook (notifica solo a la parte afectada)
• Advertencia de uso mensual al 80% (solo propietario)
• Límite de uso mensual excedido (solo propietario)
• Nueva solicitud de despliegue (solo propietario)
• Despliegue completado (solo colaborador)

Nota: las alertas son de mejor esfuerzo. Los fallos de entrega no se reintentan y el historial de notificaciones no se almacena.

9. Archivado de datos

Los datos de producción se archivan automáticamente después de 30 días. Los metadatos del registro archivado (estado, marcas de tiempo, resultados de webhook, etc.) se preservan, mientras que el payload (datos del cuerpo) se mueve a almacenamiento separado.

Política por entorno:

Después del archivado:

• Los registros permanecen visibles en la lista de registros (metadatos preservados)
• La búsqueda de payload está limitada a los últimos 30 días
• Los payloads individuales se pueden ver mediante "Ver original"

Descarga de archivos:

• Ubicación: Panel > Archivos
• JSONL.gz: registros completos con todos los campos del sistema (archivo sin procesar)
• CSV: solo campos de payload, aplanados recursivamente (profundidad máx. 5), compatible con Excel (UTF-8 BOM)
• Cada archivo contiene los registros de producción de un día
• Disponible solo en planes de pago