Referencia de la API - Ready for Commerce

URL base

https://app.readyforcommerce.com

La ruta de cada operación empieza por /api/v1, y las operaciones de una organización están bajo /api/v1/orgs/{orgId}/. Las peticiones y las respuestas son JSON.

Autenticación

Cada llamada envía una llave de API de la organización como token Bearer, en la cabecera Authorization. La crea una persona de la organización en la aplicación, en Ajustes › API y conexiones › Llaves de API. Mantenla fuera de tu código: léela de una variable de entorno o de un almacén de secretos, como hacen estos ejemplos con RFC_API_KEY.

curl https://app.readyforcommerce.com/api/v1/credential \
  --header "Authorization: Bearer $RFC_API_KEY"

import os

import requests

response = requests.get(
    "https://app.readyforcommerce.com/api/v1/credential",
    headers={"Authorization": f"Bearer {os.environ['RFC_API_KEY']}"},
)
print(response.json())

<?php
$curl = curl_init('https://app.readyforcommerce.com/api/v1/credential');
curl_setopt_array($curl, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('RFC_API_KEY')],
    CURLOPT_RETURNTRANSFER => true,
]);
echo curl_exec($curl);

const response = await fetch('https://app.readyforcommerce.com/api/v1/credential', {
  headers: { Authorization: `Bearer ${process.env.RFC_API_KEY}` },
});
console.log(await response.json());

Esta primera llamada, Obtener la credencial que llama, lee la propia llave: su organización, cuyo org.id es el orgId de todas las demás rutas, sus permisos, sus límites y las llamadas que aún puede hacer. No cuenta para ningún límite. Una llave desconocida, revocada o vencida recibe 401 con el código core.invalid_credential.

Errores

Una llamada fallida responde application/problem+json: su code nombra lo que falló, como core.validation_failed o core.rate_limited, y sus params tienen los valores que lo explican. La página de cada operación lista los códigos que puede responder.

Grupos de operaciones

Credenciales

La credencial que llama: su organización, sus permisos, sus límites y las llamadas que aún puede hacer.

Organización

Los ajustes de la organización: su nombre, su slug y su moneda.

Facturación

La suscripción de la organización, la factura y el tope de cada módulo, y el uso del mes.

Tipos de registro

Los tipos de registro que la credencial puede importar o exportar, con los campos y opciones de cada uno.

Importaciones

Para traer archivos CSV o Excel: subir o traer un archivo, inspeccionarlo y revisarlo, e importarlo.

Archivos

El estado de un archivo subido, hasta que queda listo o rechazado.

Exportaciones

Para exportar a archivos CSV o Excel los registros que coinciden con un filtro.

Plantillas de exportación

Configuraciones de exportación guardadas con un nombre, para repetir la misma exportación.

Trabajos

Para seguir las tareas largas: su estado y su avance, sus mensajes y archivos, o cancelarlas.

Búsqueda

Encuentra los registros de la organización por palabras, aunque lleven una errata, agrupados por tipo.

Historial de versiones

Las versiones de un registro: compararlas y restaurar el registro a una de ellas.

Incidencias

Los problemas de la organización que puedes ver: marcarlos como leídos o no leídos y resolverlos.

Notificaciones

Tus notificaciones, de la más nueva a la más antigua: marcar una como leída o no leída, o todas como leídas.

Vistas guardadas

La búsqueda, los filtros, el orden y las columnas de una tabla guardados con un nombre, tuyos o compartidos.

Conexiones de tienda

Las tiendas de la organización: listarlas, conectar una, reconectarla con credenciales nuevas o desconectarla.

Productos

Los productos de la organización con sus opciones y variantes: leer uno o crear uno.