Your first call

In a few minutes you will check your API key, read your organization and read its usage this month. Each step shows the call in curl, Python, PHP and JavaScript; choose your language once and every step follows it.

You need an API key of your organization. If you have none, create one and put it in the environment variable RFC_API_KEY:

export RFC_API_KEY="<your key>"

Check your key

Get the calling credential answers who your key is. It counts against no limit.

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

The answer starts like this:

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

It goes on with limits, your key’s calls a minute, and remaining, the calls it may still make now (see Rate limits). Keep org.id: it is the orgId of every other path.

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

Read your organization

Get the organization reads its name, its slug and its currency.

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"
}

Read this month's usage

Get this month’s usage answers, for each module, how many of each unit the organization used this month (count), its free allowance (freeAllowance) and what is left of it (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());

Your key works. A call that fails answers application/problem+json with a code that says why: see Errors.

Next steps

Errors

The shape of every error, and what to do with the common ones.

Pagination

Read a whole list, a page at a time.

Rate limits

The calls a key may make, and how to retry a write safely.

API reference

Every operation, with its fields, its errors and examples.

Get started

Using the API

AI assistants

Next steps

Errors

Pagination

Rate limits

API reference