Fundamentos

Autenticación

Todas las llamadas a la API se autentican mediante una API Key enviada en el header X-API-Key. No se utilizan tokens OAuth, ni Basic Auth, ni cookies de sesión: este header es la única credencial que la API espera.

Esquema de autenticación

  • Tipo: API Key.
  • Header: X-API-Key: <tu_clave>.
  • Transporte: obligatorio sobre HTTPS.
  • Visibilidad: la clave en texto plano solo se muestra al momento de crearla. Si la pierdes, no podrás recuperarla — tendrás que generar una nueva.

Cómo obtener una clave

  1. Inicia sesión en el panel y entra a /app/api-keys.
  2. Haz clic en Nueva API Key, asígnale un nombre y, opcionalmente, una lista de IPs autorizadas.
  3. Copia la clave generada en ese instante. No se podrá ver de nuevo.

Ejemplo de solicitud autenticada

bash
curl -X GET https://www.factura-tor.com/api/customers?businessId=1 \
  -H "X-API-Key: 3f7c...e91a" \
  -H "Accept: application/json"
javascript
const res = await fetch('https://www.factura-tor.com/api/customers?businessId=1', {
  headers: {
    'X-API-Key': process.env.FACTURATOR_API_KEY,
    'Accept': 'application/json',
  },
});

if (!res.ok) {
  const problem = await res.json();
  throw new Error(problem.detail || problem.error || res.statusText);
}

const { data } = await res.json();

Restricciones que aplica la API

Una llamada se rechaza si:

  • El header X-API-Key no viene en la solicitud — devuelve 401.
  • La clave no existe o fue desactivada — devuelve 401.
  • Tu plan actual no incluye acceso a la API — devuelve 403.
  • Configuraste una whitelist de IPs y la solicitud llega desde una IP no incluida — devuelve 403.

Respuestas comunes de autenticación

API Key ausente

json
{ "error": "API Key is missing" }

API Key inválida o inactiva

json
{ "error": "Invalid or inactive API Key" }

Plan sin acceso al API

json
{
  "error": "API access not included in your current plan.",
  "message": "Please upgrade your subscription to use the API."
}

IP no autorizada

json
{ "error": "IP address not whitelisted" }

Revocación

Desde el panel puedes desactivar o eliminar una clave en cualquier momento. Tras desactivarla, las siguientes llamadas reciben 401 de inmediato.