Crear nuevo endpoint

Resumen

Un endpoint es una URL que puede recibir datos JSON de sistemas externos. 3Min API almacena los datos entrantes, registra logs y opcionalmente los reenvía mediante webhooks.

En esta página, solo necesita ingresar un nombre, descripción y campos obligatorios opcionales para crear un endpoint. Los campos obligatorios se pueden modificar más adelante en la página de detalles, así que no dude en omitirlos al principio.

Después de la creación

• Se crea automáticamente en el entorno Sandbox
• Se emite inmediatamente una clave API de Sandbox (prefijo tm_test_)
• También se emite una clave API de Producción (tm_live_), pero las llamadas de Producción se rechazan y no se registran hasta el despliegue
• Se genera automáticamente un enlace a una página de guía de integración pública (pruebas estilo Swagger + ejemplos de código)

Cómo llegar aquí

• Botón Nuevo endpoint en la esquina superior derecha del Panel
• Menú izquierdo APIs → Botón Crear nueva API en la esquina superior derecha de la página de listado

---

General

Nombre de la API

Campo obligatorio.

• Un nombre visible para el usuario para distinguir el endpoint
• La ruta real de la API (slug) se genera automáticamente, así que elija un nombre que refleje la naturaleza de sus datos
  • Buenos ejemplos: contact-form, order-notification, wine-shop-sale
  • Evite: test, api1, my endpoint
• Restricciones:
  • No puede estar vacío
  • Debe ser único dentro de la misma cuenta
  • Se aplica un límite máximo de longitud (se muestra un mensaje de error si se excede)

Descripción

Campo opcional.

• Una descripción de texto libre del propósito del endpoint
• Registre cuándo se llama a este endpoint y qué tipo de datos recibe para los colaboradores y para usted en el futuro
• Ejemplo: "Notificación de confirmación de pedido activada al completar la compra"
• Se puede editar en línea más adelante en la página de detalles

Campos obligatorios

Opcionales. Puede agregarlos más adelante en la página de detalles en cualquier momento.

Predefina los campos JSON que deben incluirse en las llamadas API. Si un campo definido falta en la solicitud, la llamada se rechaza.

Campos de entrada por registro

• Nombre del campo: La clave del campo (ej., order_id, customer_email)
• Tipo de datos: Elija entre String, Number, Boolean, Object, Array
• Buscable: Marque esta opción para usar el campo como palabra clave de búsqueda en la página de registros
• Descripción del campo (opcional): Descripción para compartir con los colaboradores

Restricciones

• Buscable solo está disponible para campos de tipo String
• Buscable está limitado a 2 campos por endpoint
• Los nombres de campo deben comenzar con una letra o guión bajo, y solo contener letras/números/guiones bajos
• No se permiten nombres de campo duplicados

Validación

Solo verifica si la clave existe en el JSON — el contenido o formato del valor no se valida.

Puede omitir esto por ahora

Si no se definen campos obligatorios, el endpoint acepta cualquier payload JSON. Cree el endpoint primero, pruebe en Sandbox, determine qué campos son necesarios y luego agréguelos en la página de Detalles del endpoint.

Lo que no está en esta página

• Configuración de webhooks — Se configura en la página de detalles del endpoint después de la creación
• Configuración de notificaciones — También en la página de detalles
• Gestión de claves de colaboración / Invitaciones — Se gestionan en Claves de colaboración en la página de detalles
• Despliegue a Producción — Use el botón Desplegar a producción en la página de detalles

Después de la creación

Haga clic en Crear API para navegar automáticamente a la página de detalles del endpoint. Continúe desde ahí:

1. Consulte la URL del endpoint real en la tarjeta de Resumen
2. Pruebe una llamada de Sandbox con la clave API por defecto
3. Configure Webhook / Notificaciones / Claves de colaboración si es necesario
4. Cuando esté listo para Producción, despliegue con Desplegar a producción

---

Solución de problemas

• ¿Puedo cambiar el nombre después? — Sí, puede editarlo en cualquier momento en el Resumen de la página de detalles, incluyendo la descripción
• ¿Necesito múltiples endpoints? — En la mayoría de los casos, no. 3Min API utiliza almacenamiento tipo documento, por lo que puede enviar JSON anidado como un solo payload a un único endpoint. Solo separe los endpoints cuando los eventos sean fundamentalmente diferentes (ej., pedidos vs. consultas)
• ¿Debo definir campos obligatorios estrictos? — Comience sin ninguno, pruebe con los colaboradores y luego agregue solo los campos que realmente deban estar siempre presentes