1. Uso de API
  • Uso de API
    • 1. Introducción
    • 2. Ambientes Disponibles
    • 3. Seguridad
    • 4. Respuestas
    • 5. Tipos de Parámetros
    • 6. Errores
    • 7. Por dónde comenzar
    • 8. Webhooks
    • 9.-Adjuntos
  • Apis
    • 8.1. Documentos
      • Nuevo Documento
      • Listar DTEs
      • Listar DTEs V.2
      • Obtener Documento
      • Listar Documentos Adjuntos
      • Adjuntar archivo o documentos a un DTE
      • Dejar un comentario en la bitacora de un documento
      • Listar los registros de bitácora de un DTE
      • Asociar contacto a un DTE
      • Enviar DTE por correo electrónico
      • Generar una acción comercial sobre un DTE
      • Actualizar información de pago de un documento
      • Obtener información de pago de un documento
      • Cargar Borrador DTE
      • Nuevo Documento Portafolio Contrato
      • Carga Masiva Documentos Contrato
      • Listar tipos de Documentos de Escritorio Digital
      • Enviar a flujo expedientes
      • Listar opciones v2
      • Listar flujos para aprobaciones
    • 8.1.2 No Tributario
      • Nuevo Documento No Tributario
      • Listar DNTs
      • Actualizar Documento No Tributario
      • Obtener información de un documento
      • Actualiza Estado de Documento No Tributario
      • Buscar DTE referenciados a un DNT
    • 8.1.3 Documentos Personalizados
      • Convertir documento personalizado a expedientes para Escritorio Digital
      • Obtener listado de documentos personalizados
      • Crear un documento
    • 8.2. Folios
      • Cargar un CAF
      • Anular un CAF
      • Listar CAFs cargados
      • Listar CAFs
      • Solicitar un rango de folios para sucursal
      • Listar rangos de folios entregados a sucursales
      • Listar distribución de folios consumidos y por usar
      • Obtener Folios de un CAF
    • 8.3. Empresas
      • Articulos
        • Categorias
          • Listar categorias
          • Crear Categoria
          • Actualizar
          • Eliminar
        • Descuentos
          • Listar Descuentos
          • Crear Descuento
        • Listar artículo de venta
        • Buscar artículos
        • Crear artículo de venta
        • Eliminar artículo de venta
        • Actualizar artículo de venta
      • Listar mis empresas
      • Crear una empresa
      • Buscar Sucursales de una empresa
      • Crear sucursal
      • Actualizar Sucursal
      • Eliminar Sucursal
      • Obtener sucursal
      • Crear Choferes de una empresa
      • Buscar choferes de una empresa
      • Obtener Chofer
      • Actualizar Choferes de una empresa
      • Modificar Choferes de una empresa
      • Eliminar chofer
      • Crear transportistas de una empresa
      • Buscar transportistas de una empresa
      • Obtener un transportista
      • Actualizar un transportista
      • Modificar un transportista
      • Marcar eliminado un transportista
      • Crear vehiculos de una empresa
      • Buscar vehiculos de una empresa
      • Obtener vehiculo
      • Actualizar vehiculo
      • Modificar vehiculo
      • Eliminar Vehiculo
      • Cargar Certificado Digital para la Empresa
      • Obtener el certificado digital cargado en el sistema
      • Listar correos de la empresa enviados o recibidos por medio de Febos
      • Modificar grupo de unidad organizativa
      • Actualizar usuarios de grupo de unidad organizativa
      • Eliminar grupos de unidad organizativa
      • Crear Lista Personalizada
      • Listar Lista Personalizada
      • Eliminar lista personalizada
      • Modificar lista personalizada
      • Modificar lista personalizada
      • Listar elementos de lista personalizada
      • Invitar Proveedor
      • Buscar Proveedores
      • Listar árbol de usuarios dentro de grupos
      • Listar Unidades y oficinas de Escritorio Digital
      • Consultar información de una empresa
      • Lista Suplencias de Empresa
    • 8.4. Seguridad
      • Listar roles
      • Listar permisos de rol
      • Ingreso programático
      • Crear Token permanente
      • Listar Token
    • 8.5. Utilidades
      • Pre firmar URL para upload
      • Subir archivo para proceso
      • Realizar acción masiva
      • Encolar tarea en background
      • Consulta estado de tarea en background
      • Historial de Eventos
      • Crear ticket de soporte
    • 8.6. SII
      • Generar AEC.
    • 8.7. Firma Electrónica
      • Firmar un documento
      • Recuperar Firmas Disponibles
    • 8.8. Usuarios
      • Listar Usuarios
      • Listar Roles de Usuario
      • Obtener Usuario
      • Latido de usuario
      • Listar Grupos Usuario
    • 8.9. Impuestos
      • Listar Impuestos
    • 8.10. Aprobaciones
      • Previsualización documentos de aprobación
      • Listar Ejecuciones en Aprobaciones
      • Enviar archivo a flujo de firma
      • Obtener estado de ejecucion
    • 10. Configuraciones
      • Obtener objeto con configuraciones
  • Schemas
    • Schemas
      • Aprobaciones
        • AprobacionCrearResponse
        • Aprobacion-Paso
      • Articulos
        • Categoria
      • Estructura básica de un adjunto
    • BaseResponse
    • BaseListResponse
  1. Uso de API

4. Respuestas

Febos tiene 2 tipos de respuestas, por un lado estan las respuestas a nivel de aplicación, es decir aquellas que son producidos por en las entrañas de Febos, ya sean una respuesta de error o un mensaje de acción realizada satisfactoriamente. Por otro lado, estan los errores que son producidos por la tecnología que utiliza Febos, estos mensajes son en ingles y ocurren en casos muy particulares, siendo 2 mensajes los que más se repiten y se explican mas abajo.

4.1. Campos estandar#

Todas las respuestas de Febos, incluso aquellas que corresponden a un error, son retornadas con el codigo HTTP 200, es decir, a nivel de procolo web, indican una respuesta "correcta" (incluso siendo un error). Esto se debe a que en la búsqueda de la compatibilidad con sistemas externos, los cuales deben integrarse con Febos, se encuentran sistemas tanto antiguos como modernos, y en ocasiones puede ser complejo administrar los distintos códigos HTTP que el protocolo provee (como el famoso código 404 cuando algo no es encontrado). En reemplazo, Febos provee un código de respuesta en TODAS sus respuestas, siendo el código 10 un código de error satisfactorio (es decir la acción solicitada se llevo a cabo de forma exitosa), y cualquier otro código numérico significa que se ha producido un error. Los códigos numéricos de error menos a 10 estan relacionados con autenticación y autotización, mientras que los códigos de error superiores al código 10, son errores de lógicas de negocio, configuración o errores más complejos. Cada respuesta de Febos contará con 2 campos fijos, más un tercer campo opcional:
codigo: (int) Este campo representa el código del resultado de la ejecución de la API, tal como se explica más arriba, 10 es una respuesta satisfactoria, mientras que cualquier otro código es error.
mensaje: (string) Traducción humana del código anterior.
errores: (arreglo de string) Contiene los distintos errores que se estan produciendo, o el detalle del error que se produjo.
seguimientoId: (string) Código único de solicitud, cada respuesta contiene un código único que identifica la llamada, con este identificador nuestro equipo puede ver los logs relacionados al proceso para ayudar en caso de ser necesario. Es altamente recomendable almacenar este identificador (o registrarlo en los logs de su integración).
duracion: (int) Tiempo en milisegundos que tardo en procesarse la solicitud. Este número no toma en cuenta el tiempo que tardó en enviarse la solicitud ni recibirse la respuesta (es decir tiempos de comunicación), si no que solo tiempos de proceso.

4.2. Respuestas fuera de nuestro control#

Debido a que Febos opera sobre Amazon, existen algunos errores que no podemos controlar, los cuales escapan a la lógica de los mensajes estandar de Febos. Éstos errores estan muy bien identificados, y especifican a continuación:

4.2.1. Timeout#

Nunca una respuesta de la API de Febos demorará más de 30 segundos en responder, en un caso en que la el proceso detrás de la API tarde mas de 30 segundos, el error retornado tendrá una estructura similar a la estándar, solo que con menos campos, y el campo ´codigo´ representa el código de error HTTP (400,404,500, etc):
codigo: (int) Este campo representa el código del resultado de la ejecución de la API, tal como se explica más arriba, 10 es una respuesta satisfactoria, mientras que cualquier otro código es error.
mensaje: (string) Traducción humana del código anterior.
errores: (arreglo de string) contiene el error que retorna AWS

4.2.2. Endpoint no existe#

Si te confundes por alguna razón, o existe un error en tu aplicación, podrias recibir el error descrito más abajo, el cual indica que el Endpoint que estas consumiento no existe. Es decir estas invocando una URL incorrecta, o el VERBO (get, post, put, etc) utilizado no se corresponde con esa URL, el error retornado tendrá una estructura similar a la estándar, solo que con menos campos, y el campo ´codigo´ representa el código de error HTTP (400,404,500, etc):
codigo: (int) Este campo representa el código del resultado de la ejecución de la API, tal como se explica más arriba, 10 es una respuesta satisfactoria, mientras que cualquier otro código es error.
mensaje: (string) Traducción humana del código anterior.
errores: (arreglo de string) contiene el error que retorna AWS
Modificado en 2025-09-16 19:42:26
Anterior
3. Seguridad
Siguiente
5. Tipos de Parámetros
Built with