Skip to main content

​
Comienza en tres pasos

Integra Yampi.ai con tus sistemas y automatiza tus procesos inmobiliarios siguiendo estos pasos simples.

​
Paso 1: Obtén tu token de acceso

Para autenticarte con la API de Yampi.ai, necesitas un token de acceso. Este token se encuentra en tu perfil de usuario.
1

Accede a tu perfil

  1. Inicia sesión en Yampi.ai
  2. Navega a tu perfil de usuario desde el menú lateral izquierdo (menú de usuario en la esquina inferior izquierda)
  3. Desplázate hasta la sección “Token de acceso API”
  4. Copia tu token de acceso
Mantén tu token de acceso seguro y nunca lo compartas públicamente. Si crees que tu token ha sido comprometido, regenera uno nuevo desde tu perfil.
2

Guarda tu token de forma segura

Almacena tu token como variable de entorno o en un gestor de contraseñas:
export YAMPI_API_TOKEN="tu_token_aqui"
En producción, usa variables de entorno o un gestor de secretos. Nunca hardcodees tokens en tu código fuente.

​
Paso 2: Realiza tu primera llamada

Ahora que tienes tu token, puedes hacer tu primera llamada a la API. La URL base de la API es https://app.yampi.ai/api/v1. 
curl -X GET 'https://app.yampi.ai/api/v1/accounts/{account_id}' \
  -H 'api_access_token: tu_token_aqui'

const response = await fetch('https://app.yampi.ai/api/v1/accounts/{account_id}', {
  headers: {
    'api_access_token': process.env.YAMPI_API_TOKEN,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Reemplaza {account_id} con el ID de tu cuenta. Puedes encontrar este ID en la URL cuando estás navegando en la aplicación web de Yampi.ai o al final de la página de tu perfil de usuario.

​
Paso 3: Explora los endpoints disponibles

Una vez que hayas realizado tu primera llamada exitosa, puedes explorar todos los endpoints disponibles para integrar diferentes funcionalidades. 
{
  "id": 1,
  "name": "Mi Inmobiliaria",
  "domain": "mi-inmobiliaria",
  "created_at": "2024-01-15T10:30:00Z"
}

Contactos

Gestiona propietarios, inquilinos y leads mediante la API de contactos.

Propiedades

Administra tu catálogo de propiedades, precios y condiciones.

Conversaciones

Integra el sistema de mensajería y comunicación unificada.

Tesorería

Automatiza pagos, suscripciones y dispersiones financieras.

​
Próximos pasos

Ahora que has realizado tu primera integración, explora estas funcionalidades:

Referencia completa de API

Consulta todos los endpoints disponibles con ejemplos detallados.

Autenticación

Aprende más sobre los diferentes tipos de tokens y permisos.

Webhooks

Configura notificaciones en tiempo real para eventos importantes.

Mejores prácticas

Optimiza tus integraciones siguiendo nuestras recomendaciones.
¿Necesitas ayuda? Consulta nuestra documentación completa o contacta a nuestro equipo de soporte.