Primeros pasos

De cero a tu primera respuesta en cuatro pasos, con los ejemplos ya apuntando a tu cluster.

Quickstart

Cuatro pasos, quince minutos, un 200 OK. Todos los ejemplos de esta página ya apuntan al cluster y entorno que elegiste en el panel lateral — cámbialos ahí y se reescriben solos.

Tu host actual

…

México · Stage

x-api-key

Obtén tu API key

Pide tu API key a tu contacto de Mendel. Vas a recibir una key por entorno: la de Stage no sirve en Producción y viceversa. La key ya define el cluster sobre el que operas. Si tiene acceso a una sola compañía, tampoco hace falta que indiques cuál; si tiene acceso a varias, lee Uso multi-compañía.

No la expongas en el cliente

La API key da acceso a datos sensibles de tu empresa. Úsala solo desde tu backend: nunca en una app web o móvil, nunca en un repo.

Identifica tu host

Todos los clusters comparten la misma estructura de rutas (/api/public/v1/…); lo único que cambia es el host. Elige tu cluster y entorno en la barra superior y todos los ejemplos del portal se reescriben solos.

# Base de todas las rutas
https://mx.stage.app.mendel.com/api/public/v1

Ver Clusters y entornos para la lista completa.

Haz tu primera solicitud

Autentica con el header X-API-KEY y lista las compañías a las que tu key tiene acceso.

curl -X GET 'https://mx.stage.app.mendel.com/api/public/v1/companies' \
  -H 'X-API-KEY: tu_api_key_aqui' \
  -H 'Accept: application/json'

Un 401 significa key ausente o inválida; un 403, que la key no alcanza para ese recurso. El detalle está en Manejo de errores.

Recorre las páginas

Las colecciones responden en formato HAL: los elementos van en _embedded y los metadatos de paginación en page. Usa page y size para avanzar.

curl -X GET 'https://mx.stage.app.mendel.com/api/public/v1/purchases?page=0&size=20' \
  -H 'X-API-KEY: tu_api_key_aqui'

page.totalPages te dice cuántas páginas hay. Ver Paginación (HAL).

Y después

En esta página