3Min API

Inicio rápido

3 minutos es todo lo que necesitas. Desde el registro hasta tu primera prueba de API.

1. Registrarse

Comienza rápidamente con Google. Obtienes 1.000 solicitudes API gratuitas al mes.

2. Crear endpoint

1
Panel → APIs → Botón Nuevo endpoint
2
Ingresa el nombre de la API
  • La descripción es opcional
3
Configuraciones opcionales
  • Campos obligatorios
    • Marca campos específicos como obligatorios. Las solicitudes que no los incluyan serán rechazadas.
    • Los campos de cadena se pueden marcar como buscables para filtrar registros.
  • Webhook
    • Reenvía datos a servicios externos como Slack o Discord.
    • Separado de los webhooks de colaboradores — esto es para tus propias integraciones.
4
Haz clic en Crear API
  • La URL del endpoint y los métodos CRUD (POST/GET/PUT/DELETE) se generan al instante
  • Las claves API predeterminadas se emiten automáticamente (la clave de Sandbox está lista para usar, la clave de Producción está disponible después del despliegue)
  • También se crea una página de prueba integrada — sin necesidad de herramientas adicionales

3. Prueba: primera llamada API y verificación de registros

Prueba inmediatamente después de crear un endpoint y verifica la recepción en los registros.

Panel → APIs → Detalle del endpoint → Botón Probar ahora
  • Prueba llamadas API reales en el entorno Sandbox
Panel → Registros
  • Verifica que los datos se estén guardando correctamente
  • Los registros pueden tardar hasta 3 segundos en aparecer

4. Crear clave de colaboración e invitar colaboradores por correo

Una vez que las pruebas del propietario estén completas, crea una clave de colaboración e invita colaboradores por correo electrónico.

Panel → APIs → Detalle del endpoint → Claves de colaboración → Ver todo
  • Haz clic en "Agregar" para crear una clave de colaboración
  • Abre la página de detalles de la clave de colaboración y envía una invitación por correo
  • Los colaboradores invitados pueden registrarse, ver sus claves API, registros y estadísticas desde su propio panel

5. Pruebas de integración

Verifica que tu colaborador pueda llamar a la API correctamente en Sandbox.

  • El colaborador verifica su clave API de Sandbox en la página de detalles del endpoint
  • El colaborador prueba la API en el entorno Sandbox
  • Revisa Panel → Registros para confirmar que los datos de la solicitud se reciben correctamente

6. Desplegar a producción

Una vez que las pruebas estén completas, despliega a Producción. El propietario puede desplegar directamente o aprobar una solicitud de despliegue de un colaborador.

Panel → APIs → Detalle del endpoint → Botón Desplegar a producción
  • El colaborador solicita el despliegue mediante el botón "Solicitar despliegue" en la página de detalles del endpoint
  • El propietario puede desplegar directamente o revisar y aprobar la solicitud de un colaborador
  • Una vez desplegado, el colaborador es notificado automáticamente y puede acceder a su clave API de producción