Llaves y cuenta corporativa: un sistema, una llave.
La cuenta personal usa llaves propias y la corporativa, las credenciales de máquina de tu empresa en la plataforma de REDCUMBRE. El llamado es el mismo. Lo que agrega la corporativa sirve para integrar varios sistemas a la vez: carpetas, alcance por llave y roles.
01
Dos cuentas, un mismo llamado
Mismo host, misma API, mismo contrato. Lo que cambia entre una cuenta y otra es de dónde sale la llave y en qué cabecera va. Y en las dos, si un documento es de prueba o real lo decide la llave, nunca un parámetro: pasar de prueba a real es cambiar la llave.
Las llaves de la cuenta personal y de la cuenta corporativa
Cuenta
La llave
Cabecera
Prueba o real
Además
Personal
La creas tú en el panel, en «API Keys» del menú de usuario, con el panel en modo real: eliges el entorno y los permisos, «Lectura» y «Escritura», que vienen las dos marcadas. Hasta 10 activas por cuenta.
X-API-Key: vf_live_…
Lo decide el entorno que eliges al crearla: «Producción (live)» da una llave vf_live_ y «Desarrollo (test)», una vf_test_.
Por llave, registro de uso (GET /api/auth/api-keys/{id}/logs) y plantilla del correo de invitación: logo, colores, asunto, nombre visible del remitente, dirección de respuesta y HTML propio. La dirección que envía es siempre la del sistema.
Corporativa
Es una credencial de máquina de tu empresa en la plataforma de REDCUMBRE (rCAPI), con un token pedido para la audiencia del proyecto ValidaFirma. ValidaFirma no emite llaves para la cuenta corporativa.
Authorization: Bearer …
Lo declara la plataforma de REDCUMBRE para cada credencial: de prueba o de producción. ValidaFirma no mira el formato del token.
Alcance y carpeta por defecto por llave, carpetas compartidas, roles.
En la cuenta corporativa la credencial se presenta como Authorization: Bearer, y ValidaFirma consulta su contexto en la plataforma de REDCUMBRE. Mandada enX-API-Key se rechaza con 401 como una API key inválida:INVALID_API_KEY_FORMAT, «La API Key no tiene un formato válido».
Si la credencial alcanza más de una cuenta, cada llamado lleva además X-Cuenta-Id con la cuenta en la que opera; sin él, responde 409 CUENTA_NO_NOMBRADA.
Que una credencial sea de prueba o de producción lo declara la plataforma de REDCUMBRE: ValidaFirma no mira el formato del token. Una de prueba abre el modo de prueba con las mismas reglas que una real del mismo alcance, carpetas incluidas. Más en el modo de prueba.
El ejemplo indica carpeta_id, que sólo existe en la cuenta corporativa. Si no lo mandas, el documento nace en la carpeta por defecto de la llave y, si no tiene una, en su carpeta personal.
GET /api/auth/whoami es la primera llamada de una integración: dice de qué cuenta es la llave, en qué modalidad y en qué modo. Antes de crear el primer documento, confirma que la cuenta y el modo son los que esperas.
El nombre de la llave, para que sepas cuál de tus sistemas está llamando.
credencial.sandbox
true con una llave de prueba y false con una real. Es la misma forma en que responde rCAPI.
En la cuenta personal es la misma llamada, con X-API-Key.
03
Una llave por sistema
En la cuenta corporativa cada sistema que integra —el ERP, el portal de recursos humanos, el CRM— debería tener su propia credencial. Así cada uno tiene su alcance y su carpeta por defecto, y cada documento queda registrado con la llave que lo creó, o con la persona, si lo creó alguien desde el panel.
Alcance de cuenta
Ve, crea, reenvía y cancela en cualquier carpeta de la cuenta, carpetas personales incluidas. No mueve documentos ni administra carpetas.
Acotada a carpetas
Ve y opera sólo las carpetas donde un administrador le dio acceso, con el nivel de cada una, y los documentos que ella creó. Sin ninguna carpeta, ve sólo lo suyo.
La carpeta por defecto
Un administrador puede marcar una de las carpetas de una llave como su carpeta por defecto. Si el ERP de recursos humanos tiene «Contratos» como carpeta por defecto, todo lo que crea sin carpeta_id nace en Contratos, y tu código no necesita saber el identificador de la carpeta. Si la llave no tiene carpeta por defecto, lo que crea sin carpeta_id nace en su carpeta personal.
Si la carpeta por defecto se archiva, lo que la llave cree sin carpeta_id se rechaza con409 CARPETA_POR_DEFECTO_ARCHIVADA, un mensaje que la nombra («Tu carpeta por defecto «X» está archivada…») y la carpeta en carpeta, con su id y sunombre.
Rotar conserva. Regenerar la credencial en rCAPI mantiene sus accesos y su carpeta por defecto.
Revocar borra. Una llave eliminada pierde sus accesos, y la que la reemplace parte sin ninguno: no los hereda.
Sólo las rutas del integrador. Una llave crea, consulta, reenvía, cancela, descarga y lista sus carpetas. También ve los firmantes y las estadísticas, calcula el costo, pide, consulta y descarga exportaciones del archivo, y llama a whoami y a la simulación del modo de prueba. No administra carpetas ni accesos, no emite poderes de firma y no ve el secreto de webhooks.
04
Carpetas
Las carpetas agrupan los documentos de la cuenta corporativa por faena, obra, área o cliente. Son planas, sin subcarpetas, y un documento está en una sola. No cuestan nada. Sólo un administrador las crea, las renombra, las archiva y reparte accesos, a personas o a llaves, desde el panel: esa administración no es parte de la API.
Cuatro niveles de acceso
Qué permite cada nivel sobre los documentos de una carpeta
Nivel
En el panel
Ve
Crea
Reenvía o cancela
Saca documentos
lectura
«Ve todo, no crea»
Todos
No
No
No
escritura
«Crea y ve sólo lo suyo»
Sólo los que creó
Sí
Los que creó
No
lectura_escritura
«Ve todo, crea y opera»
Todos
Sí
Cualquiera
No
gestion
«Ve todo, opera y mueve»
Todos
Sí
Cualquiera
Sí
El nivel va con su valor en la API y, al lado, la etiqueta con que lo muestra el panel. No es una escala:escritura deja crear y ve menos que lectura.
El rol manda sobre el nivel. Administradores y revisores ven todo; un operador ve sus carpetas y su carpeta personal.
La carpeta personal es donde nace un documento creado sincarpeta_id por quien no tiene carpeta por defecto. La ven quien lo creó, los administradores, los revisores y las llaves con alcance de cuenta.
Carpeta obligatoria. Un administrador puede encender «Exigir que todo documento nuevo nazca en una carpeta», que viene apagado. Con la exigencia encendida, un documento sin carpeta_id nace igual en la carpeta por defecto de la llave. Si no tiene una, y las personas nunca la tienen, se rechaza con 400 CARPETA_OBLIGATORIA, o con409 CUENTA_SIN_CARPETAS_ACTIVAS si la cuenta no tiene ninguna carpeta activa.
Archivar no borra. Una carpeta archivada no recibe documentos nuevos; los que tiene siguen consultables, y los pendientes se pueden reenviar o cancelar.
Las carpetas desde tu sistema
Al crear, indicas la carpeta con carpeta_id. Para saber cuáles alcanza tu llave,GET /api/fes/carpetas lista las que ves, con tu nivel en cada una y es_defecto: true en tu carpeta por defecto, y trae ademáscarpeta_obligatoria, que dice si la cuenta exige carpeta. Con alcance de cuenta las ves todas; donde la llave no tiene un acceso propio, nivel llega nulo conorigen_del_acceso: "rol". Por defecto lista las activas: ?estado=acepta activa, archivada o todas, ylimite va de 50 por defecto a 200 como máximo. En una cuenta personal responde404 CARPETAS_NO_DISPONIBLES: ahí las carpetas no existen.
En la cuenta corporativa, los usuarios y sus roles los gobierna rCAPI: en ValidaFirma no se asignan. Cada persona entra con su acceso de REDCUMBRE y tiene uno de tres roles. También cuentan como administradores el administrador de la empresa en la plataforma de REDCUMBRE y la operación de REDCUMBRE, que no puede cambiar la protección del plan.
AdministradorVALIDAFIRMA_ADMINTodo lo de la cuenta: crea y archiva carpetas, reparte accesos, emite poderes de firma, ve y rota el secreto de webhooks y maneja la protección del plan. Ve todos los documentos de la cuenta.
RevisorVALIDAFIRMA_REVISORVe y descarga todo lo de la cuenta, incluidas las carpetas personales, exporta el archivo y ve la bitácora. No escribe nada: no crea, no reenvía, no cancela.
OperadorVALIDAFIRMA_OPERADORCrea documentos y opera lo suyo y lo de las carpetas donde tiene acceso, con el nivel que tiene en cada una.
Cada documento queda registrado con la persona o la llave que lo creó, y la bitácora registra lo que hacen en la cuenta las personas, las llaves y REDCUMBRE.
Ante el firmante, quien envía es la empresa, con su razón social, nunca la persona o la llave que creó el documento.
Los avisos al emisor de lo que crea una llave, como el correo con enlace al panel cuando el documento queda firmado, llegan al correo de avisos de la cuenta y, si no hay uno, a los administradores.
Lo que la cuenta corporativa ofrece a la empresa, más allá de la integración, está en el Plan empresa.
06
Cobro
Cuenta personal
Paga por firma, $690 + IVA por firmante
La respuesta de creación trae el bloque creditos, conconsumidos, costo_por_firmante,saldo_restante, transaccion_id,es_prueba y sandbox.
Cuenta corporativa
Mensualidad, con firmas incluidas
La respuesta no trae creditos sino cobro, con "prepago": false y "modalidad": "corporativa", y nada más. La mensualidad y la factura viven en la plataforma de REDCUMBRE: ValidaFirma sólo lee las firmas incluidas de tu plan.
Con la protección del plan encendida, al agotarse las firmas incluidas se congela la creación de documentos; con un plan de 0 incluidas nunca congela. Un administrador puede apagarla en el panel, y entonces lo adicional se firma y se factura; queda apagada hasta que un administrador la vuelva a encender. Al 80 % y al 100 % de las incluidas, el panel lo muestra en su indicador; ValidaFirma no manda esos avisos por correo.
Mientras congela, la creación responde 409 con "error": "PROTECCION_DEL_PLAN", firmas_incluidas_mes, convocados_del_mes y mensaje. Si alcanzas el tope de seguridad, medido en una ventana móvil de 24 horas, responde 409 con "error": "TOPE_ALCANZADO", "tope": "ventana_24h", mensaje y url_solicitud_aumento.
En las dos, lo que crea una llave de prueba no se cobra. Los precios están en precios.
07
Secreto de webhooks
Cada aviso del webhook va firmado con un secreto de la cuenta, uno por modo: whsec_live_ para lo real y whsec_test_ para lo de prueba. Lo ve y lo rota sólo una persona con sesión en el panel, en la tarjeta «Secreto de webhooks»: «Revelar», luego «Copiar» y «Ocultar», y «Rotar». En la cuenta personal está en «API Keys», del menú de usuario, que sólo existe en las cuentas personales. En la corporativa la sección es del administrador, con el rol VALIDAFIRMA_ADMIN: quien opera o consulta no tiene entrada a ella. Una credencial de máquina que lo pide recibe403 SECRETO_SOLO_CON_SESION_DE_PERSONA.
Al rotarlo, el modal «Rotar el secreto de webhooks» pregunta qué pasa con el anterior: «Deja de firmar ahora», la opción marcada, o «Sigue firmando 24 horas». Con la segunda, durante esas 24 horas el aviso trae dos firmas, una con cada secreto, y vale cualquiera. Se confirma con «Sí, rotar». Los documentos creados con una llave que después se revoca siguen mandando sus webhooks. Cómo comprobar la firma, en webhooks.
Preguntas sobre llaves
Lo que se pregunta al conectar la empresa
¿Puedo usar una llave vf_live_ en la cuenta corporativa?
No. Las llaves vf_live_ y vf_test_ son de la cuenta personal. En la corporativa la llave es una credencial de máquina de tu empresa en la plataforma de REDCUMBRE, y va en la cabecera Authorization: Bearer. Si la mandas en X-API-Key, se rechaza con 401 como una API key inválida.
¿Cómo pruebo la integración en la cuenta corporativa?
Con una credencial que la plataforma de REDCUMBRE declare de prueba. El host, la API y el contrato son los mismos; lo que crea esa llave es de prueba, no envía mensajes y no se cobra. Pasar a real es cambiar la llave. Los detalles están en el modo de prueba.
¿Una llave puede crear carpetas o emitir poderes de firma?
No. Una llave alcanza sólo las rutas del integrador: crear, consultar, reenviar, cancelar, descargar, listar sus carpetas, ver firmantes y estadísticas, calcular el costo, pedir, consultar y descargar exportaciones del archivo, whoami y la simulación del modo de prueba. Las carpetas, los accesos, los poderes y el secreto de webhooks los maneja una persona administradora, en el panel.
¿Puedo tener mi cuenta personal y la de mi empresa?
Sí. Una persona puede estar en su cuenta personal y en varias empresas, y un selector en el panel muestra cuál está usando. Cada cuenta tiene sus documentos, sus llaves y su cobro.
La cuenta corporativa parte con una conversación
Te contamos cómo se activa en rCAPI, qué plan calza con lo que firmas al mes y cómo ordenar las carpetas y las llaves de tus sistemas.