Skip to main content
Sales de esta página con tres cosas: la base URL, un token de usuario y un account_id con el que puedas llamar un recurso real. Si aún no tienes claro el producto, lee antes Qué es Yampi.

​
Base URL

La API de cuenta vive bajo /api/v1/. Casi todo lo de una inmobiliaria cuelga de:

​
Autenticación

Envía el token en el header api_access_token:
Si el header está presente, Yampi autentica con ese token. Si no, usa la sesión de la app.

​
De dónde sale el token

Cada usuario tiene un AccessToken. En GET /api/v1/profile el campo access_token trae el valor actual; ahí también ves las cuentas (accounts) con id, role y suite_role. Para regenerarlo:
La respuesta es de nuevo el perfil, con el token nuevo.

​
Primera llamada

1

Obtén el perfil

Llama GET /api/v1/profile con tu token y guarda un accounts[].id.
2

Elige la cuenta

Ese id es tu account_id. Casi todas las rutas de producto lo llevan en el path.
3

Lista un recurso

Por ejemplo, las propiedades de la cuenta 42:
Si ves 401 / Invalid Access Token, el header no llegó o el token no existe.

​
Siguiente paso

  • Conceptos — cuenta, suites y el mapa del dominio.
  • Pestaña API — contrato HTTP por endpoint.
  • Pestaña MCP — lectura con OAuth Bearer (el conector MCP no usa api_access_token).