Ir al contenido
API para desarrolladores

FISCALISTO / AYUDA

Llaves y solicitudes

Cree, cambie y revoque las llaves de su API, y revise cada solicitud que hizo su sistema.

Las llaves

Su sistema se identifica con una llave en el encabezado Authorization: Bearer de cada solicitud. Las llaves de pruebas empiezan con fk_test_ y las de producción con fk_live_. Guárdelas en una variable de entorno de su servidor, nunca en el código ni en una app que se instala en teléfonos.

Paso a paso

  1. Abra Llaves en el modo que necesita y pulse Nueva llave.
  2. Escriba un Nombre para reconocerla. En Permisos deje Todos, o elija Solo lectura para una llave que consulta facturas, saldo y catálogos pero no timbra, cancela ni cambia nada (para un tablero o su equipo de soporte). En Vence elija Nunca o un plazo; le avisamos por correo 7 días y 1 día antes. Si la llave solo debe timbrar con ciertos RFC, marque Solo para algunos emisores y elíjalos.
  3. Pulse Crear llave. Se muestra completa una sola vez: cópiela y pulse Ya la guardé. Con una llave de pruebas puede también descargar la colección con esta llave e importarla en Postman, Bruno o Insomnia para probar cada ruta sin escribir código.
  4. Para cambiarla sin cortes, elija Cambiar llave en su menú. Le damos una llave nueva con el mismo nombre, permisos y plazo, y en La llave actual deja de funcionar elige cuándo se apaga la anterior: Ahora mismo, En 1 hora, En 24 horas o En 7 días.
  5. Si una llave ya no se usa, elija Revocar: deja de funcionar al momento.

Las llaves de producción timbran facturas reales con sus timbres. Para crearlas su usuario necesita la verificación en dos pasos, que activa en Ajustes › Seguridad.

Un entorno de prueba para cada persona

Si varias personas de su equipo prueban con la misma cuenta, dele a cada una su propio entorno. En Llaves, en modo de pruebas, pulse Nuevo entorno en Entornos de prueba, escriba su Nombre (por ejemplo, el de quien lo usa) y pulse Crear entorno. Recibe una llave que se muestra una sola vez: désela a esa persona. Con ella solo ve el emisor de pruebas, las facturas, los webhooks y los eventos de su entorno, y al reiniciar los datos de prueba solo borra los suyos. Su llave aparece en la lista con la etiqueta Entorno y su nombre.

Cuando ya no lo necesite, pulse Borrar junto al entorno: su llave deja de funcionar al momento y sus webhooks se borran, sin tocar nada de la cuenta ni de los demás. Puede tener hasta 25.

Llaves para el CLI

Desde su terminal, npx fiscalisto login pide una llave sin que tenga que copiarla. Le muestra un código y abre Autorizar el CLI: revise que el código sea el mismo, elija su cuenta API y pulse Autorizar (o No autorizar si usted no lo pidió). El CLI recibe una llave de pruebas llamada «CLI · el nombre de su computadora», que aparece en Llaves y revoca como cualquier otra. Si el CLI pidió también una de producción, marque También una llave de producción; necesita la verificación en dos pasos. El código vence en 10 minutos y sirve una vez.

Las solicitudes

Solicitudes muestra cada llamada a la API del modo elegido, la más reciente primero: el código de respuesta, el método, la ruta, el error y cuánto tardó. Al abrir una ve Lo que mandó y Lo que respondimos, sin contraseñas ni archivos de sellos. Lo que prueba con Probar en la documentación de la API sin llave aparece con la llave «Documentación». Cada respuesta trae un encabezado Request-Id; búsquelo aquí o mándelo a soporte. Con varias llaves, elija una en Todas las llaves para ver solo sus solicitudes. En Llaves, debajo de Usada, cada llave dice cuántas solicitudes hizo en los últimos 7 días y qué parte terminó en error; púlselo para abrir esas solicitudes.

Si la solicitud falló, Cómo arreglarlo dice qué significa el error, qué campo corregir y, si el SAT la rechazó, su regla (por ejemplo CFDI40147), con el enlace a la guía de errores. Copiar como curl la copia lista para la terminal, con la llave de la variable FISCALISTO_API_KEY; en Como código elija TypeScript, Python, PHP, Go, Java o C# para verla escrita con el SDK. Debajo de los datos aparecen la Versión de la API con que se respondió y, si llevaba Idempotency-Key, la llave con su botón para copiarla. Las que se mandaron otra vez con la misma llave dicen Repetida en la lista: recibieron la misma respuesta que la primera sin hacerse otra vez. Con la misma Idempotency-Key las muestra juntas, la original primero; pulse una para abrirla. En pruebas, Repetir en pruebas abre el cuerpo para que lo corrija y, con Enviar, la manda otra vez con una Idempotency-Key nueva; la respuesta se abre enseguida y queda en la lista. Las solicitudes de producción no se repiten desde aquí, ni las que llevaban contraseñas o archivos de sellos.

El Workbench

En cualquier página de Desarrolladores, el botón Workbench (o la tecla `) abre un panel abajo sin dejar la página:

  • Resumen: las solicitudes de las últimas 24 horas y cuántas fallaron, la versión de la API de su cuenta, sus webhooks y los errores más frecuentes.
  • Solicitudes: la lista y, al elegir una, todo lo de arriba (Cómo arreglarlo, Como código, Con la misma Idempotency-Key).
  • Eventos: cada evento, lo que se mandó y a qué webhook llegó.
  • Webhooks: cada webhook y sus últimas entregas.
  • Inspector: escriba el id de un objeto (inv_…, cus_…) para verlo como lo lee su código; en Expandir ponga campos como issuer para traerlos completos. Los ids de la respuesta abren el suyo.
  • Shell: elija el método, escriba la ruta (o búsquela en Rutas) y pulse Enviar. Siempre llama en modo de pruebas, como usted, y queda en Solicitudes con la llave «Panel».

Ejemplo

Su llave de producción se subió por error a un repositorio público. Abra Llaves, elija Cambiar llave con Ahora mismo, ponga la nueva en su servidor y revise en Solicitudes con Solo errores si alguien intentó usar la anterior.

Si su sistema recibe un error

Un 401 significa que falta la llave o ya no sirve: revise que no esté revocada y que use la de producción en producción. Un 400 trae en param el campo que hay que corregir. Si una factura tardó y no sabe si se timbró, repita la solicitud con el mismo Idempotency-Key: nunca se timbra dos veces.