@qcobro/sdk,
que la envuelve con métodos tipados de extremo a extremo. Además, hay un endpoint REST
dedicado para registrar gestiones desde integraciones externas.
Formas de llamar a la API
Con el SDK (recomendado)
@qcobro/sdk envuelve la API tRPC con recursos tipados, valida en el cliente y gestiona
los tokens por ti. Es la vía recomendada para la mayoría de integraciones.tRPC directo
Llama a cualquier procedimiento por el proxy tipado
client.trpc del SDK, incluso a los
que aún no tienen método de recurso.Endpoint REST de gestiones
Un endpoint HTTP sencillo para registrar el resultado de una gestión en un workspace desde
un sistema externo.
Autenticación
Cómo autenticar las peticiones y acotarlas a un workspace.
URL base
La API de QCobro está enhttps://api.qcobro.com. La API tRPC vive bajo la ruta /trpc; los
endpoints REST, bajo /api. El SDK usa esa base por defecto, así que normalmente no necesitas
configurarla.
Cada petición se acota a un workspace
Casi todas las operaciones actúan dentro de un workspace. Al llamar a la API tRPC, indicas el workspace activo con la cabecerax-workspace, cuyo valor es el accessKeyId del
workspace. El SDK la fija por ti cuando llamas a client.useWorkspace(...).
Validación y errores
Las entradas se validan contra los esquemas compartidos de QCobro. Una entrada inválida produce un error de validación estructurado, con detalle por campo (code, message,
fieldErrors). El SDK lo expone como ValidationError y, además, valida en el
cliente antes de enviar la petición.
Siguientes pasos
Autenticación
Tokens, la cabecera de workspace y las API keys.
Endpoint de gestiones
Registra el resultado de una gestión vía REST.