¿Cómo se generar el Token?

DESCRIPCIÓN

Un token para un servicio REST es un código único y seguro que se utiliza para autenticar y autorizar las solicitudes de un cliente hacia el servidor. Este token se genera desde la aplicacion en la nube y se utiliza para asegurar que solo los usuarios válidos puedan acceder a los recursos protegidos de los servicio de la API.

GENERACION TOKEN DESDE LA APLICACIÓN EN LA NUBE

Esto se puede lograr siguiendo los pasos que detallo a continuación: accede al menú desplegable (también conocido como "menú hamburguesa") y selecciona la opción "Configuración", posteriormente navega hacia "Configuración General".

Como se muestra en la siguiente guía visual:

Seguridad

Dentro de la sección: “Configuración”, elige la opción “API”. Aquí encontrarás un listado de cuentas de servicio API que permitirá generar un token para la cuenta de servicio seleccionada.

Seguridad

Dentro de la tabla encontrará el historial de los tokens generados para cada una de las cuentas de servicio únicamente podrá contar con un token activo, y tendrá la opción de revocar el token y generar uno nuevo de ser necesario. la fecha de vencimiento podrá ser modificada pero debe tener en cuenta que esta fecha no podrá ser mayor a la fecha de vencimiento de su licencia ni menor a la fecha actual de la generación del token.

Seguridad

Si haces clic sobre el token, este se copiará automáticamente al portapapeles, listo para ser utilizado. Puedes visualizar este proceso en la imagen.

Seguridad

No dudes en contactarnos si necesitas más asistencia o aclaraciones respecto a este procedimiento. Estamos aquí para ayudarte.

INCLUSIÓN DE TOKEN

Una vez se genera el token se debe incluir en el encabezado de cada petición de los servicio para tener una conexión exitosa, se debe anteponer el prefijo “WO” de la siguiente forma “WO Token“:

Inclusión de Token

En caso que no se envié el sistema le retornara un 401 Unauthorized

Inclusión de Token

Administrador Permisos Usuario API

Opciones de permisos para usuarios de la API

Para administrar los accesos de los usuarios de la API a diferentes servicios, puede configurar sus permisos de forma preferente. El proceso comienza con la creación del usuario:

Accede a la sección de Seguridad y luego a Usuarios.

Seguridad

Las cuentas de servicio se pueden crear haciendo clic en el botón flotante de la vista de usuarios y seleccionando la opción 'Cuenta API'.

Seguridad

Si necesitas modificar un usuario existente, haz clic en los tres puntos al lado derecho del usuario y elige Editar.

Seguridad

Observarás que estos usuarios tienen asignado el rol de Api, el cual no puede ser alterado.

Seguridad

Al crear el usuario, notarás que todos los permisos de acceso de las cuentas API están habilitados por defecto. Para restringir permisos específicos, dirígete a Permisos Detallados. Allí encontrarás un menú donde puedes habilitar o deshabilitar las opciones disponibles.

Seguridad

Al seleccionar una de las opciones del menú, verás que se despliega una lista en la que puedes activar o desactivar los permisos para cada uno de los servicios disponibles en la API.

Seguridad

Glosario de Respuestas y Errores

TIPO_DOCUMENTO_NO_ADMITO_API:

Para los servicios de compras y ventas, se requiere incluir el parámetro "documentoTipo", el cual debe obtenerse del servicio "Listar tipos de documentos". Si, por ejemplo, el proceso en curso es una Compra y el parámetro indicado es "FV", se generará este mensaje de error, y se debe cambiar el parámetro por un tipo de documento válido para compras.

EMPRESA_ERRADA:

El ID de la empresa ingresada no está registrado en el sistema. Por favor, verifique el ID de la empresa o regístrela correctamente antes de continuar.

TERCERO_ERRADO:

El tercero ingresado no se encuentra registrado en el sistema. Asegúrese de que el tercero sea válido y esté registrado antes de continuar con la operación.

DIRRECCION_TERCERO_EXTERNO_ERRADO:

La dirección del tercero externo no se encuentra registrada. Verifique la dirección proporcionada o asegúrese de que el tercero externo esté registrado con la dirección correcta.

FORMA_PAGO_NO_SOPORTADA:

La forma de pago ingresada no se encuentra registrada en el sistema. Por favor, elija una forma de pago válida o regístrela antes de continuar con la transacción.

ERROR_MONEDA:

La moneda especificada no está registrada en el sistema. Asegúrese de utilizar una moneda válida o regístrela adecuadamente antes de proceder.

PREFIJO_FACTURA_ERRADO:

El prefijo ingresado no se encuentra registrado. Verifique el prefijo proporcionado o asegúrese de que esté registrado en el sistema.

BODEGA_NO_EXISTE:

La unidad de inventario no está registrada en el sistema. Por favor, asegúrese de utilizar una unidad válida o regístrela antes de continuar.

CENTRO_COSTO_NO_EXISTE:

El centro de costo no está registrado. Verifique el centro de costo proporcionado o regístrelo adecuadamente antes de proseguir.

ERROR_UNIDAD_INVENTARIO:

La unidad de inventario no está registrada en el sistema. Por favor, asegúrese de utilizar una unidad válida o regístrela antes de continuar.

INVENTARIO_NO_ENCONTRADO:

No se encuentra registrado uno de los ID de inventarios proporcionados. Verifique los ID de inventarios o asegúrese de que estén correctamente registrados.

DOCUMENTO_MOTIVO_GENERACION_NO_REGISTRADO:

Debe ingresar un motivo de devolución válido. Asegúrese de especificar un motivo de devolución que esté registrado en el sistema antes de proceder.

ERROR_CLASIFICACION:

La clasificación ingresada no está registrada. Verifique la clasificación proporcionada o asegúrese de que esté registrada correctamente.

MAXIMO_ALCANZADO:

Para el proceso de eliminar varios registros, el límite es de 5 registros por petición. Si envía más registros, recibirá esta respuesta. Asegúrese de enviar un número adecuado de registros para el proceso de eliminación.

DUPLICATE_KEY:

Este error se produce cuando se encuentra registrado un documento con el mismo número que se está ajustando, y además, los campos prefijo, idEmpresa y documentoTipo coinciden. Por favor, verifique los datos para evitar duplicados en el sistema.

FECHA_ERRADA:

La fecha ingresada es incorrecta. Por favor, verifique la fecha y asegúrese de proporcionarla en el formato correcto antes de continuar.

COMPRA_NO_ENCONTRADA:

Esta respuesta indica que no se encontró ningún registro que coincida con la consulta realizada. Verifique los parámetros de búsqueda o asegúrese de que la compra exista en el sistema.

COMPRA_NO_ACTUALIZADO:

La compra no ha sido actualizada correctamente. Para obtener más detalles sobre el error, revise el campo "moreInfo" de la respuesta, donde se proporcionará una descripción detallada del problema encontrado durante la actualización.

CUENTA_CONTABLE_NO_ENCONTRADA:

La cuenta contable especificada no ha sido encontrada en el sistema. Por favor, verifique el número de cuenta contable o asegúrese de que esté registrada correctamente antes de continuar. Si la cuenta contable es requerida para una operación específica, asegúrese de proporcionar un número de cuenta válido y existente en el sistema.

ERROR_CONSULTA:

Se ha producido un error de negocio durante la consulta. Revise el campo "moreInfo" para obtener más información sobre el error específico y tome las acciones necesarias para corregirlo.

ERROR_CUENTA_CONTABLE:

La cuenta contable especificada no está registrada en el sistema. Asegúrese de utilizar una cuenta contable válida o regístrela adecuadamente antes de continuar.

ERROR_CODIGO:

El código ingresado ya ha sido registrado previamente en el sistema. Por favor, utilice un código único o verifique el registro existente correspondiente.

ERROR_NOMBRE:

El nombre ingresado ya ha sido registrado previamente en el sistema. Utilice un nombre único o verifique el registro existente asociado.

ERROR_CUENTA_CONTABLE_GRUPO:

El grupo de cuenta contable no ha sido ingresado. Asegúrese de especificar el grupo de cuenta contable correspondiente para completar el registro.

VIOLACION_INTEGRIDAD:

No es posible borrar la cuenta, ya que está vinculada a otros elementos o registros en el sistema. Para eliminar la cuenta, primero es necesario eliminar todas las referencias vinculadas a ella. Verifique las relaciones y proceda con la eliminación adecuada.

ERROR_INGRESO_RENGLONES:

Alguno de los detalles no se registró correctamente. Asegúrate de proporcionar los detalles de manera precisa y completa para que puedan ser registrados sin problemas.

DOCUMENTO_NO_ACTUALIZADO:

La venta no ha sido actualizada. Para obtener más detalles sobre el error, consulta el campo "moreInfo" de la respuesta, donde encontrarás una descripción detallada del problema que ocurrió durante la actualización.

RENGLONES_NO_ACTUALIZADO:

No se actualizaron todos los detalles del documento. Verifica que todos los detalles estén correctamente ingresados y actualizados para evitar este error.

DOCUMENTO_NO_ENCONTRADO:

El documento buscado no pudo ser encontrado en el sistema. Verifica los parámetros de búsqueda o asegúrate de que el documento esté registrado correctamente.

ERROR_FACTURACION_ELECTRONICA:

Se ha producido un error en el proceso de facturación electrónica. Por favor, revisa los detalles de la facturación y asegúrate de resolver el problema antes de continuar.

DOCUMENTO_NO_CONTABILIZADO:

Debes realizar primero el proceso de contabilización antes de proceder con la facturación electrónica. La contabilización es un paso necesario para garantizar la integridad de la información contable.

ERROR_DOCUMENTO_ELECTRONICO:

Este documento no puede ser facturado electrónicamente. Verifica si el tipo de documento es elegible para la facturación electrónica y asegúrate de cumplir con los requisitos necesarios.

ERROR_UNIDAD_INVENTARIO:

La unidad de inventario especificada no está registrada en el sistema. Asegúrate de utilizar una unidad válida y registrada antes de continuar con la operación.

INVENTARIO_NO_ENCONTRADO:

El inventario buscado no pudo ser encontrado en el sistema. Verifica los parámetros de búsqueda o asegúrate de que el inventario esté registrado correctamente.

ERROR_UNIDAD_INVENTARIO:

El ID de la unidad de medida ingresada no está registrada en el sistema. Asegúrate de utilizar un ID de unidad de medida válido y registrado antes de continuar.

ERROR_INVENTARIO_CLASIFICACION:

El ID de la clasificación de inventario no está registrado en el sistema. Verifica el ID de clasificación proporcionado o asegúrate de que esté registrado correctamente.

ERROR_INVENTARIO_TIPO_IMPUESTO_VENTA:

El ID del tipo de impuesto de venta del inventario no se encuentra registrado. Asegúrate de utilizar un ID válido y registrado para el tipo de impuesto de venta antes de continuar.

ERROR_CONTABILIZACION_NO_REGISTRADA:

El ID de contabilización no se encuentra registrado en el sistema. Asegúrate de utilizar un ID de contabilización válido y registrado antes de continuar.

ERROR_ELIMINAR_PRODUCTO_SERVICIO:

No es posible eliminar el producto, ya que está relacionado en diferentes documentos. Antes de intentar eliminarlo, verifica las relaciones y elimina cualquier vínculo asociado.

ERROR_CANTIDAD_MAXIMA_CARACTERES_PERMITIDOS:

Supera la cantidad máxima de caracteres permitidos para el campo de código. Asegúrate de que el código cumpla con las restricciones de longitud establecidas.

ERROR_UNIDAD_DE_MEDIDA:

No es posible cambiar la unidad de medida, ya que el inventario ha sido utilizado en documentos anteriores. La unidad de medida no puede modificarse si el inventario ya ha sido utilizado en transacciones previas.

TERCERO_NO_ENCONTRADO:

El tercero buscado no pudo ser encontrado en el sistema. Verifica los parámetros de búsqueda o asegúrate de que el tercero esté registrado correctamente.

ERROR_ELIMINAR_TERCERO:

No es posible eliminar el tercero, ya que está vinculado a otros elementos o registros en el sistema. Si deseas eliminar este tercero, primero debes eliminar todas las referencias o vínculos asociados. Verifica las relaciones y procede con la eliminación adecuada.

TIPO_USUARIO_NO_VALIDO:

Esta licencia registrada no permite la obtención del token a través de la API.

ERROR_ENVIO_MAIL:

Se ha producido un problema durante el intento de envío del correo electrónico.

OK_ENVIO_MAIL:

El correo electrónico se ha enviado exitosamente.

CORREO_NO_REGISTRADO:

La dirección de correo no está registrada en el sistema.

Contacto y Soporte

Puedes contactarnos creando un ticket en el centro de servicios de World Office Cloud. Nuestro equipo estará encantado de ayudarte con tus inquietudes relacionadas con la API.