> ## Documentation Index
> Fetch the complete documentation index at: https://developers.readyforcommerce.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Referencia de la API

> La URL base, cómo se autentica una llamada, cómo falla, y cada grupo de operaciones.

## URL base

```text theme={null}
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`.

```bash curl theme={null}
curl https://app.readyforcommerce.com/api/v1/credential \
  --header "Authorization: Bearer $RFC_API_KEY"
```

```python Python theme={null}
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 PHP theme={null}
<?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);
```

```javascript JavaScript theme={null}
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](https://developers.readyforcommerce.com/es/api-reference/core-get-credential.md), 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

> [card] [Credenciales](https://developers.readyforcommerce.com/es/api-reference/core-get-credential.md)
>
> La credencial que llama: su organización, sus permisos, sus límites y las llamadas que aún puede
> hacer.

> [card] [Organización](https://developers.readyforcommerce.com/es/api-reference/core-get-org.md)
>
> Los ajustes de la organización: su nombre, su slug y su moneda.

> [card] [Facturación](https://developers.readyforcommerce.com/es/api-reference/core-get-billing.md)
>
> La suscripción de la organización, la factura y el tope de cada módulo, y el uso del mes.

> [card] [Tipos de registro](https://developers.readyforcommerce.com/es/api-reference/core-list-dataio-adapters.md)
>
> Los tipos de registro que la credencial puede importar o exportar, con los campos y opciones de
> cada uno.

> [card] [Importaciones](https://developers.readyforcommerce.com/es/api-reference/core-list-imports.md)
>
> Para traer archivos CSV o Excel: subir o traer un archivo, inspeccionarlo y revisarlo, e
> importarlo.

> [card] [Archivos](https://developers.readyforcommerce.com/es/api-reference/core-get-file.md)
>
> El estado de un archivo subido, hasta que queda listo o rechazado.

> [card] [Exportaciones](https://developers.readyforcommerce.com/es/api-reference/core-list-exports.md)
>
> Para exportar a archivos CSV o Excel los registros que coinciden con un filtro.

> [card] [Plantillas de exportación](https://developers.readyforcommerce.com/es/api-reference/core-list-export-templates.md)
>
> Configuraciones de exportación guardadas con un nombre, para repetir la misma exportación.

> [card] [Trabajos](https://developers.readyforcommerce.com/es/api-reference/core-get-job.md)
>
> Para seguir las tareas largas: su estado y su avance, sus mensajes y archivos, o cancelarlas.

> [card] [Búsqueda](https://developers.readyforcommerce.com/es/api-reference/core-search.md)
>
> Encuentra los registros de la organización por palabras, aunque lleven una errata, agrupados por
> tipo.

> [card] [Historial de versiones](https://developers.readyforcommerce.com/es/api-reference/core-list-versions.md)
>
> Las versiones de un registro: compararlas y restaurar el registro a una de ellas.

> [card] [Incidencias](https://developers.readyforcommerce.com/es/api-reference/core-list-incidents.md)
>
> Los problemas de la organización que puedes ver: marcarlos como leídos o no leídos y
> resolverlos.

> [card] [Notificaciones](https://developers.readyforcommerce.com/es/api-reference/core-list-notifications.md)
>
> 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.

> [card] [Vistas guardadas](https://developers.readyforcommerce.com/es/api-reference/core-list-views.md)
>
> La búsqueda, los filtros, el orden y las columnas de una tabla guardados con un nombre, tuyos o
> compartidos.

> [card] [Conexiones de tienda](https://developers.readyforcommerce.com/es/api-reference/integrations-list-connections.md)
>
> Las tiendas de la organización: listarlas, conectar una, reconectarla con credenciales nuevas o
> desconectarla.

> [card] [Productos](https://developers.readyforcommerce.com/es/api-reference/catalog-get-product.md)
>
> Los productos de la organización con sus opciones y variantes: leer uno o crear uno.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.