Saltar al contenido principal
La API de Ready for Commerce es la de la propia aplicación. Sus pantallas, tus programas y los asistentes de IA llaman a las mismas operaciones, bajo /api/v1: lo que una persona de tu organización hace en la aplicación, un programa lo hace con una llave de API de esa organización, dentro de los permisos que tiene la llave.
Todas las operaciones están en beta hasta el lanzamiento, así que aún pueden cambiar. El registro de cambios lista cada cambio y las operaciones que toca.

Empieza aquí

1

Crea una llave de API

La crea una persona de tu organización en la aplicación, en Ajustes › API y conexiones › Llaves de API: su nombre, lo que puede hacer (Solo lectura, Acceso completo o permisos Personalizado) y cuándo vence. La llave se muestra una sola vez, al crearla.
2

Haz tu primera llamada

Envía la llave en cada llamada como Authorization: Bearer <llave>. Tu primera llamada muestra tres llamadas en curl, Python, PHP y JavaScript, desde comprobar la llave hasta leer tu organización.
3

Sigue el registro de cambios

Lee el registro de cambios, o suscríbete a su feed RSS, para saber cuándo cambia una operación que usas.

Cómo funciona la API

  • Dos formas de entrar. Los programas llaman a las operaciones con una llave de API de la organización. Los asistentes de IA se conectan al servidor MCP en https://app.readyforcommerce.com/api/mcp: una persona de la organización inicia sesión y elige lo que puede hacer, como para una llave, y el asistente llama entonces a las mismas operaciones como herramientas, nunca más allá del rol de esa persona.
  • Algunas acciones son solo de una persona. La cuenta, las personas, el dinero y las credenciales los maneja solo una persona en la aplicación: eliminar la organización o transferirla, los miembros, las invitaciones y los roles, los módulos, la tarjeta y los pagos, y las llaves de API y las conexiones de IA. No están en la referencia, y una llave que llama a una recibe 403 con el código core.human_only y su motivo en params.reason.
  • Las tareas largas corren como trabajos. Una operación que tarda, como una importación o una exportación, responde 202 Accepted con un jobId. Síguelo con Obtener un trabajo hasta que termine.
  • Los errores dicen qué falló. Una llamada fallida responde application/problem+json, con un code que nombra el problema y params con sus valores. Cada operación lista los códigos que puede responder.
  • La descripción es un archivo. La referencia se genera a partir del propio código de la API como una descripción OpenAPI 3.1, en https://developers.readyforcommerce.com/openapi/es.json, que puedes cargar en tus herramientas o usar para generar un cliente.

Guías

Autenticación

Crea una llave de API, envíala en cada llamada, protégela y reemplázala.

Tu primera llamada

Comprueba tu llave, y luego lee tu organización y su uso del mes.

Errores

La forma de cada error, y qué hacer con los más comunes.

Paginación

Lee una lista completa una página a la vez, y búscala, fíltrala y ordénala.

Límites de uso

Las llamadas que pueden hacer una llave y una organización, y cómo repetir una escritura sin riesgo.

Conectar una IA

Trabaja con tu organización desde Claude, ChatGPT u otro asistente de IA.

Explora

Referencia de la API

Cada operación, con sus campos, sus errores y ejemplos en curl, Python, PHP y JavaScript.

Registro de cambios

Cada cambio de la API, del más nuevo al más antiguo, también como feed RSS.