| Método | Propósito |
|---|---|
| Autorización | Realiza la autenticación del usuario y devuelve un token para autorizar solicitudes API. |
| Solicitud de generación de datos | Inicia la tarea de generación de datos. Soporta parámetros opcionales y permite obtener los resultados en JSON o CSV. El sistema procesa la solicitud de manera asíncrona y devuelve un ID de tarea (job ID). |
| Obtener estado de la tarea | Comprueba el estado actual de una tarea enviada previamente. Devuelve código de estado e información adicional (como número de paquetes en JSON). |
| Obtener resultado de la tarea | Devuelve el resultado de la tarea completada. El formato depende del especificado en el primer request. |
| api_get_users | Obtiene la lista de todos los usuarios de Proxima CRM, con posibilidad de filtrado. |
| api_get_company | Devuelve la lista de instituciones visitadas al menos una vez. |
| api_get_contact | Devuelve la lista de contactos visitados al menos una vez. |
| api_get_tasks | Obtiene información sobre visitas en un período específico. Soporta filtro por ID de tarea y usuario. |
| api_get_actions | Devuelve información sobre actividades no relacionadas con visitas. |
| api_get_entitymap | Devuelve el mapeo entre los nombres de campos visibles en “Acuerdo” y “Control” y las columnas del sistema según el rol. |
| api_get_pdk | Devuelve la información introducida en la tarjeta “Control” durante una visita. |
| api_get_arrangement | Devuelve información introducida en la tarjeta “Acuerdo” durante una visita. |
| api_get_preparation | Devuelve información sobre marcas y medicamentos cargados en el sistema. |
| api_get_arrangement_json | Recibe la información ingresada durante la visita en la tarjeta “Acuerdo”. El conjunto de parámetros completados depende de la configuración del cliente específico. Para obtener la configuración específica, se utiliza el método api_get_entitymap. |
| api_get_pdk_json | Recibe la información ingresada durante la visita en la tarjeta “Control”. El conjunto de parámetros completados depende de la configuración del cliente específico. Para obtener dicha configuración específica, se utiliza el método api_get_entitymap. |
| api_get_tasks_json | Recibe información sobre las visitas para el período de tiempo especificado. Se admite filtrado por ID de tareas y por ID de usuario. |
| api_get_actions_json | Devuelve información sobre la actividad no relacionada con visitas (tareas) para el período especificado. Se admite filtrado por ID de tareas y por ID de usuario. |
| api_get_users_json | Obtiene la lista de todos los usuarios del sistema Proxima CRM. Si es necesario, la lista puede filtrarse por identificadores específicos de usuarios. |
| api_get_entitymap_json | Obtiene información sobre la correspondencia entre los nombres de los campos que el usuario ve en las tarjetas “Acuerdo” y “Control” y las columnas del sistema, en el contexto de los roles de usuario. |
| api_get_company_json | Devuelve la lista de instituciones (empresas) que han sido visitadas al menos una vez. No existen restricciones respecto al período de las visitas. |
| api_get_contact_json | Devuelve la lista de clientes (contactos) que han sido visitados al menos una vez. Sin ninguna limitación temporal. |
| api_get_preparation_json | Obtiene la información sobre las marcas y los medicamentos que fueron cargados en el sistema. |