api_get_pdk – Proxima Research

Получает информацию, которую вносят на визите в карточку “Контроль”. Набор заполненных параметров зависит от настроек на конкретном клиенте. Для получения конкретных настроек используется метод api_get_entitymap.

Запрос

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Аутентификация

Bearer Token (обязателен)

Структура запиту

Заголовки

Ключ	Значение
Authorization	Bearer `<token>`
Content-Type	application/json

Тело запроса

{
    "function": "api_get_pdk",
    "format": "csv",
    "arguments": {
        "date_from": "2025-08-04",
        "date_till": "2025-08-04",
        "preparation_ids": "1,2,3,4"
    }
}

Поле	Тип	Обязательный	Описание
function	string	Да	Название метода API. Для этого запроса используйте "api_get_pdk".
format	string	Да	Формат ответа - csv
arguments	object	Да	Блок параметров.
date_from	string	Да	Дата начала формирования списка визитов (по дате начала визита). Формат YYYY-MM-DD
date_till	string	Да	Дата окончания формирования списка визитов (по дате завершения визита). Формат YYYY-MM-DD
preparation_ids	string	Нет	Принимает идентификаторы записей из БД Proxima CRM, разделённых запятыми. Используется для поиска информации по конкретным препаратам.

Успешный ответ

200 OK

Формат "csv": ответ в виде текста CSV.

Content-Type

text/plain

Пример ответа

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

Поле	Описание
preparation_id	Идентификатор препарата в БД Proxima CRM
flag1 - flag5	Поля с типом boolean
int1 - int3	Поля с типом integer
str1 - str3	Поля с типом string
date1 - date3	Поля с типом date
float1-float3	Поля с типом float
task_id	Идентификатор визита, на котором внесли данные, в БД Proxima CRM

Ошибочный ответ

40x/50x

{
  "message": "string"
}

Код	Описание
400	Неверный запрос (например, отсутствуют обязательные параметры)
401	Неавторизовано (недействительный или отсутствующий токен)
500	Внутренняя ошибка сервера

Поиск