Obtiene la información introducida durante la visita en la tarjeta “Acuerdo”.
El conjunto de parámetros depende de la configuración del cliente.
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
{
"function": "api_get_arrangement_json",
"format": "json",
"arguments": {
"date_from": "2025-08-04",
"date_till": "2025-08-04",
"preparation_ids": "1,2,3,4",
"brend_ids": "1,2,3,4"
}
}| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| function | string | Sí | Método API — "api_get_arrangement_json". |
| format | string | Sí | Formato — json. |
| arguments | object | Sí | Bloque de parámetros. |
| date_from | string | Sí | Fecha inicio de las visitas. |
| date_till | string | Sí | Fecha fin de las visitas. |
| preparation_ids | string | No | IDs de medicamentos (separados por comas). |
| brend_ids | string | No | IDs de marcas (string). |
Respuesta exitosa
200 OK
json
Ejemplo
[
{
"patalog": "Some text",
"task_id": 51970,
"brend_id": 6,
"factcount": 1,
"plancount": 1,
"potential": 1,
"preparation_id": 1
}
]| Campo | Descripción |
|---|---|
| preparation_id | ID del medicamento (sólo uno de los campos existirá). |
| brend_id | ID de la marca. |
| potential | Valor numérico float. |
| plancount | Valor numérico (float). |
| factcount | Valor numérico (float). |
| patalog | Nombre de la patología. |
| task_id | ID de la visita en Proxima CRM. |
Error
40x/50x
{
"message": "string"
}| Código | Descripción |
|---|---|
| 400 | solicitud incorrecta |
| 401 | no autorizado |
| 500 | error del servidor |