Guía de pruebas e integración

Resumen

Esta es la página que se abre al hacer clic en Probar ahora en la página de detalles del endpoint. Puede probar llamadas API directamente en el navegador sin herramientas adicionales, y compartirla con los colaboradores para que encuentren todo lo necesario para la integración en un solo lugar.

Las pruebas en esta página se realizan solo en el entorno Sandbox. No afectan los datos de Producción, así que puede experimentar libremente.

La página tiene dos pestañas:

• Inicio rápido — Autentíquese con una clave API y pruebe llamadas de inmediato
• Guía — Referencia de integración para propietarios y colaboradores (guía paso a paso, endpoints API, encabezados, definiciones de campos, ejemplos de código, etc.)

Cómo llegar aquí

• Detalles del endpoint barra lateral derecha > botón Probar ahora (pestaña Sandbox)
• Los colaboradores también pueden acceder desde su propio panel después de aceptar la invitación

---

Información del endpoint

• Se muestran el nombre y la descripción del endpoint
• Badge de entorno (Sandbox) e información de versión junto a él
• Cambie entre las pestañas Inicio rápido / Guía

Pestaña Inicio rápido

Autenticación

Para comenzar a probar, primero necesita autenticarse con una clave API.

• Pegue una clave de Sandbox (que comienza con tm_test_) en el campo de entrada y haga clic en Autorizar
• Se pueden usar dos tipos de claves:
  • Clave API por defecto — Cuando el propietario prueba directamente
  • Clave de colaboración — Cuando un colaborador prueba con su propia clave

Una vez autenticado, el campo de entrada desaparece y aparece un botón Cerrar sesión. Para probar con una clave diferente, cierre sesión y autentíquese de nuevo.

Probar

Después de la autenticación, se activa el área de ejecución de llamadas CRUD. Seleccione un método, ingrese el cuerpo de la solicitud (JSON) y haga clic en Execute para ver los resultados de inmediato.

Si quiere probar el flujo completo de una vez, siga este orden:

Guía completa de prueba CRUD

1. CREATE (POST) — Ingrese JSON de prueba en el cuerpo de la solicitud y ejecute. Copie el id de la respuesta — lo necesitará para los siguientes pasos.

2. READ (GET) — Pegue el id en el campo de Record ID y ejecute. Verifique que los datos que acaba de crear se devuelven correctamente.

3. UPDATE (PUT) — Ingrese el mismo id y proporcione JSON modificado en el cuerpo de la solicitud. Es un reemplazo completo, así que incluya los campos que quiera conservar además de los que está cambiando.

4. DELETE — Ingrese el mismo id y ejecute. Intente READ de nuevo después para confirmar que el registro ha sido eliminado.

Verificación de permisos: Al probar con una clave de colaboración, solo se pueden ejecutar los métodos permitidos por los permisos de esa clave. Llamar a un método no autorizado devuelve un error 403. Consulte los permisos en Claves de colaboración > Permisos.

Webhook de colaborador

En la parte inferior de la sección Probar, hay un área colapsable de configuración de webhook. Esto es separado del webhook que configura el propietario en el panel — es para que el llamante de la API incluya información de webhook en los encabezados de la solicitud y reciba los resultados del procesamiento en su URL especificada. Puede probar estos encabezados aquí.

• Opera independientemente del webhook del propietario
• En la integración real, los encabezados del webhook se incluyen directamente en el código de su llamada API
• Consulte la sección Configuración de webhooks de la pestaña Guía para nombres detallados de encabezados e implementación

Pestaña Guía

La pestaña Guía está estructurada para que tanto propietarios como colaboradores puedan revisar el flujo completo de integración y los detalles técnicos en un solo lugar. Las guías de pasos específicas por rol están en la parte superior, seguidas de la referencia técnica.

Primeros pasos — Propietario

Seleccione la pestaña ¿Creó usted un endpoint? para ver los pasos desde la perspectiva del propietario.

1. Crear endpoint — Solo establezca un nombre de API y el CRUD se crea automáticamente. La descripción y los campos obligatorios se pueden agregar después
2. Prueba de Sandbox y verificación de registros — Haga una llamada con la clave API por defecto en la pestaña Inicio rápido, luego verifique la recepción de datos en los registros del panel
3. Crear clave de colaboración e invitar — Cree una clave y envíe invitaciones por correo desde la página de detalles
4. Prueba de integración — Verifique junto con el colaborador que las llamadas se realizan correctamente en Sandbox mediante los registros
5. Despliegue a Producción — Apruebe la solicitud de despliegue del colaborador, o despliegue directamente. Los colaboradores son notificados después del despliegue

Primeros pasos — Colaborador

Seleccione la pestaña ¿Fue usted invitado? para ver los pasos desde la perspectiva del colaborador.

1. Aceptar invitación — Consulte el correo de invitación y acepte en el panel después de iniciar sesión
2. Consultar clave API — Encuentre su clave API de Sandbox (tm_test_) en la página de detalles del endpoint
3. Integración y pruebas — Pruebe llamadas en la pestaña Inicio rápido, y consulte la información técnica de la pestaña Guía para desarrollar su integración. Si recibe una respuesta 202, el procesamiento está garantizado por el sistema
4. Solicitar despliegue — Cuando las pruebas estén completas, envíe una solicitud de despliegue desde la página de detalles del endpoint
5. Cambiar a Producción — Una vez que el propietario complete el despliegue, será notificado. Consulte y aplique la clave API de Producción (tm_live_) desde la pestaña Producción

Endpoints API

Muestra las rutas y métodos API disponibles para este endpoint. Se preparan automáticamente cuatro métodos cuando se crea un endpoint.

Método	Ruta	Descripción
POST	/api/v1/data/{slug}	Crear un nuevo registro
GET	/api/v1/data/{slug}/{record_id}	Recuperar un registro
PUT	/api/v1/data/{slug}/{record_id}	Reemplazar un registro
DELETE	/api/v1/data/{slug}/{record_id}	Eliminar un registro

{slug} es un identificador único asignado automáticamente cuando se crea el endpoint. Puede ver el valor real en esta página.

Claves API

Información clave para la autenticación al realizar llamadas API.

Entorno	Prefijo de clave	Uso
Sandbox	tm_test_	Desarrollo y pruebas
Producción	tm_live_	Servicio en vivo

Las claves API de Producción se pueden encontrar en la página de detalles del endpoint después de que se complete el despliegue. Antes del despliegue, las llamadas con claves de Producción se rechazan.

Encabezados de solicitud

Encabezados HTTP para incluir en las llamadas API. Content-Type y Authorization son obligatorios; los encabezados de webhook solo se agregan cuando es necesario.

Encabezado	Obligatorio	Descripción
Content-Type	Obligatorio	application/json (para POST/PUT)
Authorization	Obligatorio	Formato Bearer {API_KEY}
X-Webhook-Callback	Opcional	URL para recibir el webhook del llamante
X-Webhook-Auth	Opcional	Valor de autenticación del webhook (ej., Bearer token)
X-Webhook-Auth-Header	Opcional	Clave del encabezado de autenticación del webhook (por defecto: Authorization)

Cuerpo de la solicitud

Información sobre el cuerpo JSON enviado con las solicitudes POST/PUT.

• Formato: JSON (application/json) · Máx. 100KB · UTF-8
• Si el propietario ha definido campos obligatorios, esos campos deben incluirse. Campos adicionales más allá de los obligatorios se pueden enviar libremente
• Si no se definen campos obligatorios, se acepta cualquier JSON
• Las solicitudes se procesan de forma asíncrona. Recibe una respuesta 202 inmediatamente, y el almacenamiento real y la entrega de webhooks ocurren en segundo plano

Formato de respuesta

Muestra las respuestas exitosas y los códigos de error para cada método.

Respuestas exitosas:

• POST/PUT/DELETE → 202 Accepted (solicitud aceptada y en cola)
• GET → 200 OK (datos devueltos inmediatamente)

Códigos de error:

Código	Estado	Significado
400	Bad Request	JSON inválido, campos obligatorios faltantes, ID de registro inválido
401	Unauthorized	Clave API faltante o inválida
403	Forbidden	Endpoint inactivo, sin suscripción, o permisos insuficientes
415	Unsupported Media Type	Content-Type no es application/json
429	Too Many Requests	Límite de uso mensual excedido
5xx	Server Error	Error temporal del servidor — implemente lógica de reintento

Si recibe un error 5xx, la solicitud no llegó al servidor. Implemente lógica de reintento en su código (ej., backoff de 1s → 2s → 4s). Si recibe una respuesta 202, el procesamiento está garantizado por el sistema.

Configuración de webhooks

Instrucciones para configurar webhooks del llamante para recibir automáticamente los resultados del procesamiento. Esto opera de forma separada e independiente del webhook del propietario en el panel.

Cómo configurar: Incluya los siguientes encabezados en su llamada API.

Encabezado	Obligatorio	Descripción
X-Webhook-Callback	Obligatorio	URL para recibir webhooks
X-Webhook-Auth	Opcional	Valor de autenticación (ej., Bearer token)
X-Webhook-Auth-Header	Opcional	Clave del encabezado de autenticación (por defecto: Authorization)

Política de reintentos:

• Hasta 3 reintentos en caso de fallo (backoff de 1-2 segundos)
• Criterio de éxito: código de estado 2xx
• Incluso si los 3 intentos fallan, los datos se almacenan de forma segura. Consulte el estado del webhook en los registros

Ejemplos de código

Se proporcionan ejemplos de código de llamadas API en los principales lenguajes incluyendo curl, JavaScript y Python. Cambie de pestaña para ver ejemplos en cada lenguaje. La URL real del endpoint y los encabezados requeridos ya están prellenados, por lo que puede copiarlos y usarlos de inmediato.

---

Solución de problemas

• No pasa nada al hacer clic en Autorizar: Verifique que la clave API comience con tm_test_ (clave de Sandbox). Las claves de Producción (tm_live_) no se pueden usar en esta página
• Perdí el ID después de CREATE: Ejecute CREATE de nuevo para generar un nuevo registro y continúe probando. Si necesita el ID del registro anterior, consulte el historial de llamadas en la página de Registros del panel
• Obtengo errores 403: La clave de colaboración que está usando puede no tener permiso para ese método. Consulte en Claves de colaboración > Permisos
• El webhook no llega: El servidor de webhook debe responder en 7 segundos. Verifique que sea públicamente accesible y use HTTPS. Plataformas como Discord y Slack tienen límites de velocidad — si se disparan demasiados webhooks en poco tiempo, algunos pueden ser bloqueados