Skip to main content
@qcobro/sdk es el cliente oficial de TypeScript para la API de QCobro. Se publica como un paquete ESM y funciona en cualquier runtime moderno con fetch global (Node ≥ 18 y navegadores actuales).

​
Instala el paquete

Añade el SDK a tu proyecto con tu gestor de paquetes habitual. 
npm install @qcobro/sdk

​
Construye un cliente

Importa Client y créalo. Por defecto apunta a https://api.qcobro.com; el SDK añade la ruta /trpc por su cuenta. 
import { Client } from "@qcobro/sdk";

const client = new Client();
A partir de aquí el flujo siempre es el mismo: construir el cliente, autenticarte, seleccionar un workspace y llamar a los métodos de cada recurso. Lo ves completo en Visión general del SDK.

​
Opciones del constructor

new Client(options) acepta solo ajustes opcionales.
​
endpoint
string
default:"https://api.qcobro.com"
URL base de la API de QCobro. Por defecto https://api.qcobro.com; cámbiala solo para apuntar a otro entorno. El SDK le añade la ruta /trpc.
​
fetch
function
Implementación de fetch a usar. Por defecto toma el fetch global; pásala para aportar un polyfill en runtimes antiguos.
​
accessToken
string
Token de acceso para arrancar ya autenticado, en lugar de llamar a login.
​
refreshToken
string
Token de refresco, que habilita refresh sin volver a iniciar sesión.
​
workspace
string
El accessKeyId del workspace en el que actuar. También se fija con useWorkspace.
​
autoRefresh
boolean
default:"true"
Cuando es true, una respuesta UNAUTHORIZED dispara un único refresco de token y un reintento de la petición fallida, siempre que haya un token de refresco. Ponlo en false para desactivarlo y dejar que UNAUTHORIZED aflore directamente.

​
Requisitos

  • Node.js ≥ 18 o un navegador moderno (se necesita fetch global; en su defecto, pasa uno por la opción fetch).
  • El SDK se distribuye como ESM. Úsalo desde un proyecto ESM o con un bundler que lo soporte.
  • TypeScript es opcional pero recomendado: los tipos del SDK te dan autocompletado y validación de extremo a extremo.

​
Siguientes pasos

Autenticación y tokens

Inicia sesión con contraseña o con una API key y gestiona los tokens.

Gestionar carteras

Crea, actualiza, archiva y lista las carteras de un workspace.