Ir al contenido principal

API keys

Gestionar las claves de la API pública de FacturaDirecta. Crear claves nuevas con los permisos (scopes) que necesites, consultar el catálogo de claves activas y eliminar las que ya no se usan.

API keys

La API pública de FacturaDirecta es la puerta por la que sistemas externos (tu propio software, integraciones tipo Zapier, scripts de tu gestoría, conectores de e-commerce, etc.) leen y escriben datos en tu empresa sin pasar por la interfaz web. Para llamar a esa API, cada sistema externo necesita identificarse con una API key propia, que tú generas y controlas desde aquí.

Cada clave que crees:

  • Tiene un nombre identificativo (para saber quién la usa).

  • Tiene un conjunto de permisos (scopes) que limita qué endpoints puede llamar y con qué acciones (solo lectura, o lectura + escritura, por área funcional).

  • Se ve solo una vez en su totalidad al crearla: el secreto completo no se vuelve a mostrar, así que conviene guardarlo en un sitio seguro en el momento.

  • Puedes borrarla en cualquier momento; los sistemas que la estuvieran usando dejarán de poder llamar a la API.

Cómo abrirlo

Abre Ajustes en el menú principal y entra en el bloque API. Si no ves la pestaña Ajustes en la barra superior, ábrela desde Más → Ajustes.

Identificador de tu empresa en la API

Lo primero que ves al abrir el bloque es el Identificador de tu empresa en la API (un campo de solo lectura con el ID que identifica a tu empresa en las llamadas a la API). Helper text: "Este es el valor de companyId que debes utilizar en las llamadas a la API para esta empresa. Consulta la documentación de la API para más información."

Dos elementos auxiliares:

  • Botón Copiar dentro del campo para llevar el ID al portapapeles.

  • Botón Ver documentación de la API que abre https://www.facturadirecta.com/api en pestaña nueva con la documentación pública de los endpoints.

Listado de claves existentes

Debajo, la tabla con las claves ya creadas. Cuatro columnas:

  • Nombre — el nombre que le diste al crearla.

  • Prefijo — los primeros caracteres de la clave (los únicos que se quedan visibles; el resto del secreto solo se mostró al crearla). Si la clave se creó vía API (no desde esta pantalla), aparece además un chip API con el tooltip "Clave creada vía API".

  • Fecha de creación — cuándo se generó.

  • Creada por — el email del usuario que la generó (o - si no se registró).

Si no hay ninguna clave todavía, en su lugar aparece el aviso "No tienes creada ninguna clave para la API".

Pulsa una fila para abrir el detalle de la clave (ver los permisos asignados, borrarla).

Si tu plan no incluye la API

El botón Crear nueva clave de API aparece deshabilitado y junto a él se muestra un chip de actualización de plan. La tabla de claves se oculta — el bloque solo enseña el identificador de empresa y el botón de upgrade.

Crear una clave nueva

Botón principal Crear nueva clave de API (parte inferior del bloque). Al pulsarlo se abre el diálogo Creación de clave para la API con dos secciones:

Nombre

Campo Nombre obligatorio. Helper text: "Elige un nombre para la clave que te permita poder identificarla más fácilmente según el uso que le vayas a dar." Conviene poner algo descriptivo (Zapier, Script gestoría, Web Shopify, …) porque es lo único que verás luego en el listado.

Permisos de la clave

Las casillas de los scopes que la clave podrá usar. Tres atajos arriba para selección rápida:

  • TODOS — marca todos los scopes disponibles.

  • LECTURA — marca solo los :read (la clave podrá leer datos pero no modificarlos).

  • NINGUNO — desmarca todos.

Debajo, el catálogo completo de scopes con la descripción literal de cada uno (por ejemplo, "Lectura y escritura de contactos", "Lectura de facturas", etc.). Marca los que necesites.

El botón de guardar queda deshabilitado hasta que haya un nombre y al menos un scope marcado.

Confirmación y creación

Al confirmar la creación, FacturaDirecta pide una segunda confirmación: "¿Confirmas que quieres crear ahora la clave para la API?" y, tras confirmar, genera la clave y la muestra una única vez en un diálogo aparte con un aviso claro:

IMPORTANTE: Se va a crear una clave para poder usar la API, tienes que guardar esta clave ahora en un lugar seguro porque no se volverá a mostrar en ningún otro momento.

Guarda ahora en un lugar seguro el contenido de la misma, una vez se cierre esta ventana no podrás volver a verla en el programa.

Acciones del diálogo:

  • COPIAR — copia la clave completa al portapapeles.

  • Cerrar — cierra el diálogo. Si no has guardado la clave antes de cerrar, la pierdes.

Tras cerrar, la clave aparece en la tabla con su nombre y prefijo. El secreto completo ya no es recuperable; si lo pierdes, hay que crear una clave nueva y borrar la antigua.

Ver el detalle o borrar una clave

Pulsa una fila para abrir Información de la clave de API. El diálogo muestra el nombre, el prefijo, la fecha de creación y la lista completa de Permisos de la clave que tiene asignados.

Para borrarla, pulsa el icono del diálogo y elige Borrar. FacturaDirecta pide confirmación con el aviso:

¿Estás seguro que quieres borrar esta clave de API? Tras borrar la clave cualquier llamada realizada con la misma fallará. Por favor asegúrate de que la clave ya no está en uso antes de borrarla.

Tras borrar, la clave desaparece de la tabla y deja de servir para llamar a la API. Si por error borras una clave que estaba en uso, recuérda que el secreto no es recuperable: tendrás que crear una nueva y actualizar los sistemas que la usaban.

Uso de API

En cuentas con permiso especial (soporte) o en entornos distintos de producción, aparece además el botón Uso de API junto al de creación. Abre un panel con la dashboard de uso de la API: cuántas llamadas se han hecho, por endpoint y periodo. Es información de diagnóstico, no editorial; en producción solo está disponible para el equipo de soporte.

Recursos relacionados

¿Ha quedado contestada tu pregunta?