Tu primera llamada

En pocos minutos vas a comprobar tu llave de API, leer tu organización y leer su uso del mes. Cada paso muestra la llamada en curl, Python, PHP y JavaScript; elige tu lenguaje una vez y todos los pasos lo siguen.

Necesitas una llave de API de tu organización. Si no tienes una, créala y ponla en la variable de entorno RFC_API_KEY:

export RFC_API_KEY="<tu llave>"

Comprueba tu llave

Obtener la credencial que llama responde quién es tu llave. No cuenta para ningún límite.

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());

La respuesta empieza así:

{
  "org": { "id": "0b9f4c1e-6a2d-4f8e-9c3b-7d1a5e2f8c40", "name": "Acme Outdoor" },
  "type": "api_key",
  "name": "Reportes de ventas",
  "display": "rfc_key_…X9aQ",
  "expiresAt": "2027-11-13T15:04:05.000Z",
  "permissions": ["core.billing.view", "core.jobs.view", "core.org.view"]
}

Sigue con limits, las llamadas por minuto de tu llave, y remaining, las que aún puede hacer ahora (ver Límites de uso). Guarda org.id: es el orgId de todas las demás rutas.

export RFC_ORG_ID="0b9f4c1e-6a2d-4f8e-9c3b-7d1a5e2f8c40"

Lee tu organización

Obtener la organización lee su nombre, su slug y su moneda.

curl "https://app.readyforcommerce.com/api/v1/orgs/$RFC_ORG_ID/core/org" \
  --header "Authorization: Bearer $RFC_API_KEY"

import os

import requests

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

<?php
$curl = curl_init('https://app.readyforcommerce.com/api/v1/orgs/' . getenv('RFC_ORG_ID') . '/core/org');
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/orgs/${process.env.RFC_ORG_ID}/core/org`,
  { headers: { Authorization: `Bearer ${process.env.RFC_API_KEY}` } },
);
console.log(await response.json());

{
  "id": "0b9f4c1e-6a2d-4f8e-9c3b-7d1a5e2f8c40",
  "name": "Acme Outdoor",
  "slug": "acme-outdoor",
  "defaultCurrency": "USD"
}

Lee el uso del mes

Obtener el uso del mes responde, por cada módulo, cuántas unidades de cada tipo usó la organización este mes (count), su cupo gratis (freeAllowance) y lo que queda de él (left).

curl "https://app.readyforcommerce.com/api/v1/orgs/$RFC_ORG_ID/core/billing/usage" \
  --header "Authorization: Bearer $RFC_API_KEY"

import os

import requests

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

<?php
$curl = curl_init('https://app.readyforcommerce.com/api/v1/orgs/' . getenv('RFC_ORG_ID') . '/core/billing/usage');
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/orgs/${process.env.RFC_ORG_ID}/core/billing/usage`,
  { headers: { Authorization: `Bearer ${process.env.RFC_API_KEY}` } },
);
console.log(await response.json());

Tu llave funciona. Una llamada que falla responde application/problem+json con un code que dice por qué: ver Errores.

Siguientes pasos

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.

Límites de uso

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

Referencia de la API

Cada operación, con sus campos, sus errores y ejemplos.

Primeros pasos

Uso de la API

Asistentes de IA

Siguientes pasos

Errores

Paginación

Límites de uso

Referencia de la API