Obtiene la información que se introduce durante la visita en la tarjeta “Control”.
El conjunto de parámetros completados depende de la configuración del cliente específico.
Para obtener la configuración concreta se utiliza el método api_get_entitymap.
Solicitud
Endpoint
POST https://yourdomain.pharmahrm.com/crm-api/db-function/run
Autenticación
Bearer Token (obligatorio)
Estructura de la solicitud
Encabezados
| Clave | Valor |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type | application/json |
Cuerpo de la solicitud
{
"function": "api_get_pdk",
"format": "csv",
"arguments": {
"date_from": "2025-08-04",
"date_till": "2025-08-04",
"preparation_ids": "1,2,3,4"
}
}| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| function | string | Sí | Nombre del método API. Para esta petición — "api_get_pdk". |
| format | string | Sí | Formato de la respuesta — csv. |
| arguments | object | Sí | Bloque de parámetros. |
| date_from | string | Sí | Fecha de inicio para generar la lista de visitas (según la fecha de inicio de la visita). Formato: YYYY-MM-DD. |
| date_till | string | Sí | Fecha de fin para generar la lista de visitas (según la fecha de finalización de la visita). Formato: YYYY-MM-DD. |
| preparation_ids | string | No | Identificadores de registros en la base Proxima CRM, separados por comas. Se usa para buscar información sobre medicamentos específicos. |
Respuesta exitosa
200 OK
Formato csv: la respuesta se devuelve como texto CSV.
Content-Type
text/plain
Ejemplo de respuesta
preparation_id,flag1,flag2,flag3,flag4,flag5,int1,int2,int3,str1,str2,str3,date1,date2,date3,float1,float2,float3,task_id
1,1,,,,,1,1,,,,,,,,,,,53800
3,1,,,,,2,,,,,,,,,,,,53800
10,1,,,,,3,,,,,,,,,,,,53800| Campo | Descripción |
|---|---|
| preparation_id | Identificador del medicamento en la base de datos Proxima CRM. |
| flag1 - flag5 | Campos de tipo boolean. |
| int1 - int3 | Campos de tipo integer. |
| str1 - str3 | Campos de tipo string. |
| date1 - date3 | Campos de tipo date. |
| float1-float3 | Campos de tipo float. |
| task_id | Identificador de la visita en la base Proxima CRM donde se introdujeron los datos. |
Respuesta de error
40x/50x
{
"message": "string"
}| Código | Descripción |
|---|---|
| 400 | Solicitud no válida (por ejemplo, faltan parámetros obligatorios). |
| 401 | No autorizado (token inválido o ausente). |
| 500 | Error interno del servidor. |