Api de integración Dodo DOCS

01Qué es

Es el API que permite conectar cualquier aplicación externa —un CRM, un ERP, etc.— con Dodo DOCS, ya sea con un API REST (Representational State Transfer) o un API SOAP (Simple Object Access Protocol).

El API ofrece métodos para trabajar con los registros de cualquier formulario creado en Dodo DOCS —clientes, proveedores, historias laborales, y otros—, con sus flujos de trabajo, y con varias opciones adicionales.

02Cómo se guardan los datos de un formulario

Cada formulario que se crea en Dodo DOCS queda registrado como una fila en la tabla Formularios, de la que interesa la columna IdFormulario. A partir de ese Id, la tabla Campos funciona como un diccionario: dice qué columna de la base de datos corresponde a qué campo visible del formulario.

Las columnas ID, Usuario, Fecha, Host, Imagen, Radicado, IdSucursal, IdFormulario, ID_EXT, Estado, Cod_Barras y Anio existen en todos los formularios; las columnas con nombre C0001, C0002, C0003… son las que crea cada usuario al diseñar su formulario.

03Métodos del API

Estos son los métodos disponibles, agrupados por lo que hacen.

Autenticación

• GetToken: genera el token dinámico para consumir los demás métodos. El token expira entre 1 y 5 minutos después de generado.
• Api_Version: devuelve la versión actual del API.

Registros de un formulario

• Form_GetData: recupera uno o varios registros de un formulario.
• Form_Insert: crea un registro en un formulario y, opcionalmente, adjunta archivos.
• Form_Update: actualiza un registro existente.
• Form_Delete: elimina un registro.
• Form_GetParameters: recupera la información de creación de un registro.
• Form_GetFileCodes: recupera los códigos de archivo de un registro, a partir de su número de radicado.
• Form_GetBase64StringFile: retorna un archivo como cadena codificada en base 64, a partir de su código.
• Form_AttachFiles: adjunta uno o varios archivos a un registro.
• Form_GetFilesDirectories: recupera los directorios de un formulario.

Archivos

• File_CopyToFather: copia un archivo de un registro de un formulario detalle a un directorio del formulario principal.
• File_CopyToEP: copia un archivo a un directorio de la estructura archivística.
• File_Delete: elimina un archivo cargado en la aplicación.

Flujos de trabajo

• Workflow_Start: inicia un flujo de trabajo.
• Workflow_RunTask: cumple una tarea en un paso específico de un flujo.
• Workflow_ReturnTask: devuelve la tarea actual a un paso anterior.
• Workflow_StepsForReturn: recupera los pasos a los que se puede devolver una tarea en curso.
• Workflow_AbortProcess: interrumpe un flujo que está En curso.
• Workflow_AttachFiles: adjunta archivos a una instancia de un flujo de trabajo.
• Workflow_GetCases: recupera uno o varios flujos de un registro.
• Workflow_GetTasks: recupera el resumen de un flujo de trabajo.
• Workflow_GetFileCodes: recupera los códigos de archivo de un flujo, a partir de su número.
• Process_Parameters: recupera la información de un flujo de trabajo (sin sus pasos).

Listas y campos

• List_GetItems: recupera los ítems de una lista.
• Field_GetValues: recupera los ítems de la lista asociada a un campo de un formulario.

Sucursales, usuarios y notificaciones

• Offices_GetOffices: recupera las sucursales creadas en la aplicación.
• User_Info: retorna la información general de un usuario.
• SendEmail: crea un registro en la tabla de notificaciones (envía un correo).