Ruta del menú: Panel > APIs > Nombre del endpoint

Detalles del endpoint

Resumen

Detalles del endpoint es la página que gestiona toda la configuración de un endpoint individual. Desde esta pantalla puede:

  • Ver y editar la información del endpoint (nombre, descripción, URL, versión)
  • Activar / desactivar
  • Desplegar y redesplegar a Producción
  • Gestionar la clave API por defecto
  • Agregar y eliminar campos obligatorios
  • Configurar webhooks y notificaciones del sistema
  • Eliminar el endpoint

La gestión de claves de colaboración (emisión de claves, invitaciones, permisos) se realiza en una página separada. Consulte Claves de colaboración para más detalles.

Si participa como colaborador, solo se muestran las secciones a las que tiene acceso (las secciones exclusivas del propietario se ocultan automáticamente).

Cómo llegar aquí

Página de listado de endpoints

  • Menú superior APIs → Haga clic en el nombre del endpoint en la lista
  • Actividad reciente del panel → Haga clic en el endpoint
  • Navegación automática después de completar el Paso 1 del Onboarding

Banner del plan Free

Se muestra en la parte superior cuando está usando el plan Free. Con el plan Free, puede crear y experimentar con endpoints tanto como desee. Se limpian automáticamente 7 días después de la creación, pero siempre puede crear nuevos — así que no dude en probar.

Botones de Activo/Inactivo y Desplegar

Área de acciones del encabezado

Área exclusiva del propietario.

  • Botón Activo/Inactivo (icono de encendido): Úselo cuando quiera pausar temporalmente las llamadas API en todos los entornos. Las llamadas se rechazan mientras está inactivo, pero los datos se conservan.
  • Botón Desplegar a producción (solo pestaña Sandbox):
    • Copia la configuración actual de Sandbox a Producción
    • Condición: Debe haber completado al menos 1 llamada de prueba en Sandbox antes de que se active

Si un colaborador accede a la página, aparece un botón Solicitar despliegue en su lugar. Envía un mensaje de solicitud de despliegue al propietario.

Pestañas de entorno

Pestañas de entorno

Debajo de la barra del encabezado, hay pestañas de Sandbox | Producción. Los dos entornos son completamente independientes.

El flujo de trabajo recomendado es: Probar en Sandbox y discutir con los colaboradoresDesplegar a ProducciónOperar. Cuando se necesiten cambios, modifique primero en Sandbox y redespliegue.

Sandbox

  • Entorno para llamadas con claves API de Sandbox (tm_test_)
  • Solo para pruebas. Experimente libremente antes de poner en marcha
  • Los datos de Sandbox se eliminan automáticamente después de 30 días (todos los planes)

Producción

  • Entorno para llamadas con claves API de Producción (tm_live_)
  • Para operaciones en vivo. Los datos se conservan permanentemente mientras su cuenta esté activa. Los registros de más de 30 días se archivan automáticamente (planes de pago)
  • Antes del despliegue a Producción, las llamadas con clave de Producción se rechazan y no se registran

Tarjeta de resumen

Tarjeta de resumen

Sección que contiene la información básica del endpoint.

Elemento Descripción
Descripción Descripción del endpoint. El propietario puede editar en línea en la pestaña Sandbox
URL del endpoint La dirección real de llamada API. Envíe solicitudes POST/GET/PUT/DELETE a esta URL. Botón de copiar incluido
Versión Versión de configuración. Se incrementa con cada despliegue
Creado Hora de creación del endpoint
Actualizado Hora del último cambio de configuración (Sandbox)
Publicado Hora del despliegue a Producción (solo pestaña Producción)

Clave API por defecto

Área exclusiva del propietario.

Clave API por defecto

  • La clave API por defecto emitida cuando se creó el endpoint
  • Se utiliza para la autenticación en la página de Guía de pruebas e integración, accesible mediante el botón Probar ahora a la derecha
  • Botón Mostrar / Ocultar para mostrar o esconder la clave en pantalla
  • Botón Regenerar: La clave anterior se invalida inmediatamente. Úselo solo cuando sospeche una exposición

Cuando un colaborador accede a la página, esta sección se reemplaza con la tarjeta de su clave de colaboración asignada.

Claves de colaboración

Claves de colaboración

Aquí solo se proporciona una tarjeta de resumen — la creación de claves, invitaciones y gestión de permisos se realizan en una página de gestión separada.

  • Vista del propietario: Botón Ver todo y resumen por colaborador (nombre, cantidad de invitaciones)
  • Vista del colaborador: Badges de permisos para la clave asignada

Consulte Claves de colaboración para instrucciones detalladas.

Campos obligatorios

Campos obligatorios

Defina los campos JSON que deben incluirse en las llamadas API. Para una explicación detallada, consulte Crear nuevo endpoint.

  • Para agregar o editar campos, haga clic en el botón Editar
  • Mientras edita, puede agregar, eliminar y cambiar tipos de campo. Finalice con Guardar o Cancelar
  • Al guardar se actualiza la configuración de Sandbox — para aplicar a Producción, necesita redesplegar
  • Incluso después del despliegue, modificar los campos obligatorios no afecta los datos ya almacenados. Las reglas de campo actualizadas se aplican solo a las nuevas llamadas entrantes

Webhooks

Área exclusiva del propietario.

Configuración de webhooks

Cuando una llamada API se procesa correctamente, se puede enviar una solicitud secundaria a la URL de webhook especificada. El almacenamiento de datos siempre se completa independientemente del éxito del webhook.

Campos de entrada

  • URL del webhook: Dirección para recibir webhooks (se recomienda HTTPS)
  • Encabezado de autenticación (opcional): Clave del encabezado de autenticación. Por defecto Authorization
  • Valor de autenticación (opcional): Valor del encabezado de autenticación. Ejemplo: Bearer abc123

Para webhooks que no requieren autenticación (receptores simples, tokens embebidos en la URL, etc.), deje los campos de autenticación vacíos.

Resumen de la política de webhooks

  • Reintento: Hasta 3 reintentos en caso de fallo, backoff de 1s → 2s
  • Tiempo de espera: Debe responder en 7 segundos. Se trata como fallo si se excede

Payload del webhook

Cuando se procesa una llamada API, se envía el siguiente payload JSON a la URL del webhook. Puede ver el formato real expandiendo la sección Ejemplo de payload del webhook en la captura de pantalla.

Campo Descripción
id ID único del registro almacenado
operation Acción realizada (create, update, delete)
status Resultado del procesamiento (success, failed)
endpoint_slug Identificador del endpoint
payload Los datos JSON originales enviados por el llamante, incluidos tal cual (null para delete)
target_record_id ID del registro objetivo (incluido para update/delete)
processed_at Hora de finalización del procesamiento

Webhooks de colaborador

Si los colaboradores necesitan webhooks, pueden configurar los suyos incluyendo X-Webhook-Callback y otros encabezados en su solicitud API. Los webhooks de colaborador operan independientemente de los webhooks del propietario, y el formato del payload es idéntico. Consulte Guía de pruebas e integración para instrucciones detalladas de configuración.

Notificaciones

Configuración de notificaciones

Separada de los webhooks, esta función envía solo eventos del sistema a Discord, Slack o Telegram. Los payloads de las solicitudes no se incluyen — solo se comunica qué evento ocurrió.

Estructura

  • Sin separación por pestaña de entorno: La configuración de notificaciones se gestiona por endpoint, no por entorno
  • Vista del propietario: Una sola tarjeta de configuración de notificaciones
  • Vista del colaborador: Tarjeta de notificaciones mostrada por clave de colaboración asignada

Campos de entrada

  • Canal: Discord / Slack / Telegram
  • URL del webhook: URL de bot/webhook preconfigurada en cada plataforma
  • Chat ID: Requerido solo para Telegram

Consulte la documentación oficial de cada plataforma para las instrucciones de configuración de webhook/bot.

Eventos de notificación

Evento Destinatario Descripción
Fallo en la entrega del webhook (solo webhook propio) Parte afectada Webhook del propietario falla → propietario / Webhook del colaborador falla → colaborador
Advertencia de uso mensual al 80% (solo propietario) Propietario El uso mensual alcanzó el 80%
Límite de uso mensual excedido (solo propietario) Propietario El uso mensual excedió el 100%
Nueva solicitud de despliegue (solo propietario) Propietario Un colaborador solicitó el despliegue a Producción
Despliegue completado (solo colaborador) Colaborador El propietario completó el despliegue

Nota

  • Los fallos en la entrega de notificaciones no se reintentan, y el historial de entregas no se almacena
  • Todos los mensajes de notificación están en inglés

Zona de peligro

Área exclusiva del propietario.

Zona de peligro

  • Botón Eliminar endpoint
  • La eliminación remueve inmediata y permanentemente:
    • La propia configuración del endpoint
    • Todos los registros API en Sandbox y Producción
    • Estadísticas relacionadas / solicitudes de despliegue / webhooks / configuración de notificaciones / claves de colaboración / metadatos de archivo
  • Los colaboradores también pierden el acceso
  • No se puede deshacer — debe escribir el nombre del endpoint en el diálogo de confirmación para proceder

Barra lateral derecha

El lado derecho de la página de detalles muestra diferentes tarjetas rápidas dependiendo del entorno.

Registros de llamadas API

Ver registros

Navegue a una página donde puede ver los resultados de las llamadas API a este endpoint. Puede consultar éxito/fallo de las solicitudes, payloads, estado del webhook y más en detalle.

Prueba de Sandbox

Se muestra en la pestaña Sandbox.

Prueba de Sandbox

Navegue a una página donde puede probar llamadas API directamente en el navegador y consultar métodos de integración. Consulte Guía de pruebas e integración para más detalles.

Consola de Producción

Se muestra en la pestaña Producción, después del despliegue, solo para el propietario.

Consola de Producción

Una consola para gestionar datos de Producción directamente desde el panel. Útil para precargar listados de productos o anuncios que los colaboradores recuperarán mediante GET. Soporta POST (crear), GET (leer), PUT (actualizar) y DELETE (eliminar). La consola se ejecuta con la clave API del propietario, y los webhooks de colaborador no se activan. Si el webhook del propietario está configurado, se activa normalmente. Consulte Consola de Producción para más detalles.

Notificación de solicitud de despliegue

Se muestra en la pestaña Sandbox.

Notificación de solicitud de despliegue

Se muestra cuando un colaborador ha solicitado el despliegue a Producción. Esta notificación también se envía por correo electrónico, así que no se la perderá. Haga clic en el botón Ver historial completo para ver el historial completo de solicitudes de despliegue.


Solución de problemas

  • El botón de desplegar está deshabilitado: O no se han realizado llamadas de prueba en Sandbox, o la última versión de Sandbox ya está desplegada en Producción. Ejecute una prueba en Sandbox primero
  • La pestaña de Producción no tiene registros: Las llamadas de Producción se rechazan hasta el despliegue, por lo que no se registran. Verifique si el despliegue fue exitoso y si se están usando claves tm_live_
  • Los campos obligatorios se cambiaron pero no se reflejan en Producción: Los cambios de Sandbox no se aplican automáticamente a Producción. Haga clic en Desplegar a producción de nuevo
  • El webhook no llega: Los servidores de webhook deben responder en 7 segundos. Verifique que el servidor sea públicamente accesible y use HTTPS. Plataformas como Discord y Slack tienen sus propios límites de velocidad — si se disparan demasiados webhooks en poco tiempo, algunos pueden ser bloqueados. Consulte también la política de límites de velocidad de la plataforma receptora