Guías por caso de uso

curl -G -H "Authorization: Bearer $ERJ_CLAVE" \
  --data-urlencode "persona=per_1" \
  --data-urlencode "desde=2026-10-01" \
  --data-urlencode "hasta=2026-10-08" \
  --data-urlencode "limit=100" \
  "https://app.elregistrodejornada.com/api/v1/fichajes"

import { ClienteErj, ErrorApi } from './sdk/typescript/src/index.ts';

const cliente = new ClienteErj({ clave: process.env.ERJ_CLAVE!, urlBase: process.env.ERJ_URL_BASE });
try {
  for await (const f of cliente.fichajes.iterar({ persona: 'per_1', desde: '2026-10-01', hasta: '2026-10-08', limit: 100 })) {
    console.log(f.secuencia, f.tipo, f.ocurridoEn);
  }
} catch (e) {
  if (e instanceof ErrorApi && e.codigo === 'rango_demasiado_amplio') console.error('Pide tramos de 31 días como mucho.');
  else throw e;
}

import os
import sys
sys.path.insert(0, "sdk/python")
from erj import Cliente, ErrorApi

opciones = {"url_base": os.environ["ERJ_URL_BASE"]} if os.environ.get("ERJ_URL_BASE") else {}
cliente = Cliente(os.environ["ERJ_CLAVE"], **opciones)
try:
    for f in cliente.fichajes.iterar(persona="per_1", desde="2026-10-01", hasta="2026-10-08", limit=100):
        print(f["secuencia"], f["tipo"], f["ocurridoEn"])
except ErrorApi as e:
    if e.codigo != "rango_demasiado_amplio":
        raise
    print("Pide tramos de 31 días como mucho.")

using ElRegistroJornada;

var cliente = new ClienteErj(new OpcionesCliente { Clave = Environment.GetEnvironmentVariable("ERJ_CLAVE")! });
try
{
    var filtros = new Dictionary<string, string?> { ["persona"] = "per_1", ["desde"] = "2026-10-01", ["hasta"] = "2026-10-08", ["limit"] = "100" };
    await foreach (var f in cliente.Fichajes.IterarAsync(filtros))
        Console.WriteLine($"{f["secuencia"]} {f["tipo"]} {f["ocurridoEn"]}");
}
catch (ErrorApi e) when (e.Codigo == "rango_demasiado_amplio")
{
    Console.Error.WriteLine("Pide tramos de 31 días como mucho.");
}

<?php
require 'sdk/php/src/ClienteErj.php';

use ElRegistroJornada\ClienteErj;
use ElRegistroJornada\ErrorApi;

$cliente = new ClienteErj(getenv('ERJ_CLAVE') ?: '');
try {
    foreach ($cliente->fichajes->iterar(['persona' => 'per_1', 'desde' => '2026-10-01', 'hasta' => '2026-10-08', 'limit' => 100]) as $f) {
        echo $f['secuencia'], ' ', $f['tipo'], ' ', $f['ocurridoEn'], "\n";
    }
} catch (ErrorApi $e) {
    if ($e->codigo !== 'rango_demasiado_amplio') { throw $e; }
    fwrite(STDERR, "Pide tramos de 31 días como mucho.\n");
}

# 1) Los informes que ya existen (informes:leer):
curl -G -H "Authorization: Bearer $ERJ_CLAVE" \
  --data-urlencode "estado=terminado" \
  --data-urlencode "desde=2026-10-01" \
  "https://app.elregistrodejornada.com/api/v1/informes"

# 2) Pedir una exportación (informes:generar: hoy, 403 ambito_insuficiente). Responde 202 con "estado": "en_cola":
curl -X POST -H "Authorization: Bearer $ERJ_CLAVE" -H "Content-Type: application/json" \
  -H "Idempotency-Key: exportacion-2026-10" \
  -d '{"tipo":"exportacion","desde":"2026-10-01","hasta":"2026-10-31"}' \
  "https://app.elregistrodejornada.com/api/v1/informes"

# 3) Consultar hasta que "estado" sea "terminado"; entonces trae "descarga" (enlace firmado, 15 minutos):
curl -H "Authorization: Bearer $ERJ_CLAVE" "https://app.elregistrodejornada.com/api/v1/informes/inf_1"

# 4) Descargar el CSV con ese enlace y la MISMA clave (otra clave recibe 404):
curl -H "Authorization: Bearer $ERJ_CLAVE" -o exportacion-2026-10.csv \
  "https://app.elregistrodejornada.com<valor del campo descarga>"

import { writeFile } from 'node:fs/promises';
import { ClienteErj, ErrorApi, ErrorEsperaAgotada, ErrorInforme } from './sdk/typescript/src/index.ts';

const cliente = new ClienteErj({ clave: process.env.ERJ_CLAVE!, urlBase: process.env.ERJ_URL_BASE });

// 1) Los informes que ya existen (informes:leer).
for await (const informe of cliente.informes.iterar({ estado: 'terminado', desde: '2026-10-01' })) {
  console.log(informe.id, informe.tipo, informe.estado);
}

// 2) Pedir una exportación, esperar a que termine y descargar el CSV (informes:generar; solo planes de pago).
const clave = 'exportacion-2026-10'; // una por informe que quieres; la MISMA al reintentar tras un corte
try {
  const creado = await cliente.generarInforme({ tipo: 'exportacion', desde: '2026-10-01', hasta: '2026-10-31' }, clave);
  const listo = await cliente.esperarInforme(creado, { plazoMs: 120_000 });
  await writeFile('exportacion-2026-10.csv', await cliente.descargarInforme(listo));
  console.log('CSV guardado:', listo.archivo?.nombre);
} catch (e) {
  if (e instanceof ErrorApi && e.codigo === 'ambito_insuficiente') console.log('Esta clave no tiene informes:generar (solo en planes de pago de la API).');
  else if (e instanceof ErrorApi && e.codigo === 'demasiados_informes_abiertos') console.log('Hay demasiados informes sin terminar: espera a que acabe alguno.');
  else if (e instanceof ErrorEsperaAgotada) console.log('Sigue en marcha; vuelve a esperarlo con el id', e.informe.id);
  else if (e instanceof ErrorInforme) console.log('No se puede entregar:', e.codigo);
  else throw e;
}

import os
import sys
sys.path.insert(0, "sdk/python")
from erj import Cliente, ErrorApi, ErrorEsperaAgotada, ErrorInforme

opciones = {"url_base": os.environ["ERJ_URL_BASE"]} if os.environ.get("ERJ_URL_BASE") else {}
cliente = Cliente(os.environ["ERJ_CLAVE"], **opciones)

# 1) Los informes que ya existen (informes:leer).
for informe in cliente.informes.iterar(estado="terminado", desde="2026-10-01"):
    print(informe["id"], informe["tipo"], informe["estado"])

# 2) Pedir una exportación, esperar a que termine y descargar el CSV (informes:generar; solo planes de pago).
clave = "exportacion-2026-10"  # una por informe que quieres; la MISMA al reintentar tras un corte
try:
    creado = cliente.generar_informe({"tipo": "exportacion", "desde": "2026-10-01", "hasta": "2026-10-31"}, clave)
    listo = cliente.esperar_informe(creado, plazo=120)
    with open("exportacion-2026-10.csv", "w", encoding="utf-8", newline="") as f:
        f.write(cliente.descargar_informe(listo))
    print("CSV guardado:", listo["archivo"]["nombre"])
except ErrorApi as e:
    if e.codigo == "ambito_insuficiente":
        print("Esta clave no tiene informes:generar (solo en planes de pago de la API).")
    elif e.codigo == "demasiados_informes_abiertos":
        print("Hay demasiados informes sin terminar: espera a que acabe alguno.")
    else:
        raise
except ErrorEsperaAgotada as e:
    print("Sigue en marcha; vuelve a esperarlo con el id", e.informe["id"])
except ErrorInforme as e:
    print("No se puede entregar:", e.codigo)

using System.Text.Json.Nodes;
using ElRegistroJornada;

var cliente = new ClienteErj(new OpcionesCliente { Clave = Environment.GetEnvironmentVariable("ERJ_CLAVE")! });

// 1) Los informes que ya existen (informes:leer).
await foreach (var informe in cliente.Informes.IterarAsync(new Dictionary<string, string?> { ["estado"] = "terminado", ["desde"] = "2026-10-01" }))
    Console.WriteLine($"{informe["id"]} {informe["tipo"]} {informe["estado"]}");

// 2) Pedir una exportación, esperar a que termine y descargar el CSV (informes:generar; solo planes de pago).
var clave = "exportacion-2026-10"; // una por informe que quieres; la MISMA al reintentar tras un corte
try
{
    var creado = await cliente.GenerarInformeAsync(new JsonObject { ["tipo"] = "exportacion", ["desde"] = "2026-10-01", ["hasta"] = "2026-10-31" }, clave);
    var listo = await cliente.EsperarInformeAsync(creado, new OpcionesEspera { Plazo = TimeSpan.FromMinutes(2) });
    await File.WriteAllTextAsync("exportacion-2026-10.csv", await cliente.DescargarInformeAsync(listo));
    Console.WriteLine($"CSV guardado: {listo["archivo"]?["nombre"]}");
}
catch (ErrorApi e) when (e.Codigo == "ambito_insuficiente")
{
    Console.WriteLine("Esta clave no tiene informes:generar (solo en planes de pago de la API).");
}
catch (ErrorApi e) when (e.Codigo == "demasiados_informes_abiertos")
{
    Console.WriteLine("Hay demasiados informes sin terminar: espera a que acabe alguno.");
}
catch (ErrorEsperaAgotada e)
{
    Console.WriteLine($"Sigue en marcha; vuelve a esperarlo con el id {e.Informe["id"]}");
}
catch (ErrorInforme e)
{
    Console.WriteLine($"No se puede entregar: {e.Codigo}");
}

<?php
require 'sdk/php/src/ClienteErj.php';

use ElRegistroJornada\ClienteErj;
use ElRegistroJornada\ErrorApi;
use ElRegistroJornada\ErrorEsperaAgotada;
use ElRegistroJornada\ErrorInforme;

$cliente = new ClienteErj(getenv('ERJ_CLAVE') ?: '');

// 1) Los informes que ya existen (informes:leer).
foreach ($cliente->informes->iterar(['estado' => 'terminado', 'desde' => '2026-10-01']) as $informe) {
    echo $informe['id'], ' ', $informe['tipo'], ' ', $informe['estado'], "\n";
}

// 2) Pedir una exportación, esperar a que termine y descargar el CSV (informes:generar; solo planes de pago).
$clave = 'exportacion-2026-10'; // una por informe que quieres; la MISMA al reintentar tras un corte
try {
    $creado = $cliente->generarInforme(['tipo' => 'exportacion', 'desde' => '2026-10-01', 'hasta' => '2026-10-31'], $clave);
    $listo = $cliente->esperarInforme($creado, 120.0);
    file_put_contents('exportacion-2026-10.csv', $cliente->descargarInforme($listo));
    echo 'CSV guardado: ', $listo['archivo']['nombre'] ?? '', "\n";
} catch (ErrorApi $e) {
    if ($e->codigo === 'ambito_insuficiente') { echo "Esta clave no tiene informes:generar (solo en planes de pago de la API).\n"; }
    elseif ($e->codigo === 'demasiados_informes_abiertos') { echo "Hay demasiados informes sin terminar: espera a que acabe alguno.\n"; }
    else { throw $e; }
} catch (ErrorEsperaAgotada $e) {
    echo 'Sigue en marcha; vuelve a esperarlo con el id ', $e->informe['id'], "\n";
} catch (ErrorInforme $e) {
    echo 'No se puede entregar: ', $e->codigo, "\n";
}